Class ArtifactExtractor

Deserializes stored attributes from ArtifactVersionAttribute records.

Converts JSON strings back to their original types for use in application.

Example

const stored = await artifactVersionAttributes.load();
const attributes = ArtifactExtractor.DeserializeFromStorage(stored);
// attributes have parsed JSON values, not strings
Copy

Extracts attributes from artifact content using the provided extract rules.

Executes each extractor function in a controlled environment with timeout and error handling. Failed extractors can either throw or return null values based on configuration.

Example

const result = await ArtifactExtractor.ExtractAttributes({
  content: '{"subject": "Hello", "body": "World"}',
  extractRules: [
    {
      name: 'subject',
      type: 'string',
      standardProperty: 'name',
      extractor: 'const parsed = JSON.parse(content); return parsed.subject;'
    }
  ]
});
// result.attributes = [{ name: 'subject', type: 'string', value: 'Hello', standardProperty: 'name' }]
Copy

Finds a specific standard property value from extracted attributes.

Convenience method for retrieving attributes mapped to standard properties like 'name', 'description', etc.

Example

const name = ArtifactExtractor.GetStandardProperty(attributes, 'name');
const description = ArtifactExtractor.GetStandardProperty(attributes, 'description');
Copy

Resolves extract rules with hierarchical inheritance.

Child artifact types inherit all rules from their parent/grandparent types, but can override rules with the same name. This method resolves the final set of rules by walking up the hierarchy and merging rules.

Example

// Parent type has rules: [{ name: 'title', ... }, { name: 'author', ... }]
// Child type has rules: [{ name: 'title', ... (override) }, { name: 'date', ... (new) }]
const resolved = ArtifactExtractor.ResolveExtractRules([
  childType.ExtractRules,
  parentType.ExtractRules
]);
// Result: [{ name: 'title' (from child), ... }, { name: 'author' (from parent), ... }, { name: 'date' (from child), ... }]
Copy

Serializes extracted attributes for storage in ArtifactVersionAttribute table.

Converts extracted attribute values to JSON strings suitable for database storage.

Example

const serialized = ArtifactExtractor.SerializeForStorage(result.attributes);
// Can now insert these into ArtifactVersionAttribute table
for (const attr of serialized) {
  await artifactVersionAttribute.save({
    ArtifactVersionID: versionId,
    Name: attr.name,
    Type: attr.type,
    Value: attr.value,
    StandardProperty: attr.standardProperty
  });
}
Copy