@manifest-editor/creator-api 1.3.0 → 1.4.0

package/dist/index.cjs

@@ -27,6 +27,8 @@ var src_exports = {};
 __export(src_exports, {
   Creator: () => Creator,
   CreatorResource: () => CreatorResource,
+  creatorHelper: () => creatorHelper,
+  defineCreator: () => defineCreator,
   getEmptyType: () => getEmptyType,
   matchBasedOnResource: () => matchBasedOnResource,
   randomId: () => randomId,
@@ -36,11 +38,13 @@ module.exports = __toCommonJS(src_exports);
 
 // src/Creator.ts
 var import_vault = require("@iiif/helpers/vault");
+var import_actions2 = require("@iiif/helpers/vault/actions");
 
 // src/CreatorRuntime.ts
 var import_actions = require("@iiif/helpers/vault/actions");
 
 // src/CreatorResource.ts
+var import_parser3 = require("@iiif/parser");
 var import_editor_api = require("@manifest-editor/editor-api");
 
 // src/ReferencedResource.ts
@@ -153,10 +157,7 @@ function matchBasedOnResource(resource, list, options) {
         continue;
       }
       if (def.supports.custom) {
-        const isValid = def.supports.custom(
-          { property, resource: parent, atIndex: resource.index },
-          options.vault
-        );
+        const isValid = def.supports.custom({ property, resource: parent, atIndex: resource.index }, options.vault);
         if (!isValid) {
           continue;
         }
@@ -174,9 +175,20 @@ function matchBasedOnResource(resource, list, options) {
   }
   return supported;
 }
+function creatorHelper(ctx, parent, property, definition) {
+  return (payload, options = {}) => {
+    if (typeof parent !== "string") {
+      options.parent = {
+        property,
+        resource: parent,
+        atIndex: options?.parent?.atIndex
+      };
+    }
+    return ctx.create(definition, payload, options);
+  };
+}
 
 // src/CreatorResource.ts
-var import_parser3 = require("@iiif/parser");
 var CreatorResource = class _CreatorResource {
   constructor(data, vault) {
     __publicField(this, "resource");
@@ -210,7 +222,6 @@ var CreatorResource = class _CreatorResource {
           const rangeRef = new ReferencedResource(range, vault);
           newRange.push(rangeRef);
           data[key] = rangeRef;
-          continue;
         }
         data[key] = newRange;
         continue;
@@ -487,13 +498,25 @@ var CreatorRuntime = class {
     this.payload = payload;
     this.configs = createConfigs;
     this.options = {
-      targetType: (options || {}).targetType || definition.resourceType,
+      targetType: options?.targetType || definition.resourceType,
       ...options || {}
     };
   }
   async run() {
     const instance = new CreatorInstance(this.vault, this.options, this.configs, this.previewVault);
     const result = await this.definition.create(this.payload, instance);
+    if (Array.isArray(result)) {
+      const results = [];
+      for (const item of result) {
+        if (item instanceof CreatorResource) {
+          results.push(item);
+        } else {
+          results.push(new CreatorResource(item, this.vault));
+        }
+      }
+      this.resource = results;
+      return this.resource;
+    }
     if (result instanceof CreatorResource) {
       this.resource = result;
     } else {
@@ -505,26 +528,29 @@ var CreatorRuntime = class {
     if (!this.resource) {
       return [];
     }
+    const allResources = Array.isArray(this.resource) ? this.resource : [this.resource];
     const actions = [];
     const resources = {};
     const mapping = {};
-    if (this.options.parent) {
-      this.resource.setPartOf(this.options.parent.resource.id);
-    }
-    const embedded = this.resource.getAllEmbeddedResources();
-    const allItems = [...embedded, this.resource];
-    for (const item of allItems) {
-      const resource = item.getVaultResource();
-      if (!resource.type || !resource.id) {
-        continue;
+    for (const resource of allResources) {
+      if (this.options.parent) {
+        resource.setPartOf(this.options.parent.resource.id);
       }
-      const type = resolveType(resource.type);
-      resources[type] = resources[type] ? resources[type] : {};
-      resources[type][resource.id] = resource;
-      mapping[resource.id] = type;
+      const embedded = resource.getAllEmbeddedResources();
+      const allItems = [...embedded, resource];
+      for (const item of allItems) {
+        const resource2 = item.getVaultResource();
+        if (!resource2.type || !resource2.id) {
+          continue;
+        }
+        const type = resolveType(resource2.type);
+        resources[type] = resources[type] ? resources[type] : {};
+        resources[type][resource2.id] = resource2;
+        mapping[resource2.id] = type;
+      }
+      actions.push((0, import_actions.importEntities)({ entities: resources }));
+      actions.push((0, import_actions.addMappings)({ mapping }));
     }
-    actions.push((0, import_actions.importEntities)({ entities: resources }));
-    actions.push((0, import_actions.addMappings)({ mapping }));
     return actions;
   }
   commit(afterActions = []) {
@@ -533,12 +559,14 @@ var CreatorRuntime = class {
     }
     const actions = this.getActions();
     this.vault.dispatch((0, import_actions.batchActions)({ actions: [...actions, ...afterActions] }));
+    if (Array.isArray(this.resource)) {
+      return this.resource.map((resource) => resource.ref());
+    }
     return this.resource.ref();
   }
 };
 
 // src/Creator.ts
-var import_actions2 = require("@iiif/helpers/vault/actions");
 var Creator = class {
   constructor(vault, configs, previewVault) {
     __publicField(this, "configs");
@@ -549,11 +577,7 @@ var Creator = class {
     this.previewVault = previewVault || new import_vault.Vault();
   }
   matchBasedOnResource(resource) {
-    return matchBasedOnResource(
-      resource,
-      this.configs || [],
-      { vault: this.vault }
-    );
+    return matchBasedOnResource(resource, this.configs || [], { vault: this.vault });
   }
   async create(definition, payload, options) {
     const foundDefinition = this.configs.find((t) => t.id === definition);
@@ -587,28 +611,31 @@ var Creator = class {
       }
     }
     const runtime = new CreatorRuntime(this.vault, foundDefinition, payload, this.configs, this.previewVault, options);
-    const resource = await runtime.run();
+    const run = await runtime.run();
+    const allResources = Array.isArray(run) ? run : [run];
     const afterActions = [];
-    if (options?.parent) {
-      if (options.parent.property === "start" || options.parent.property === "target") {
-        afterActions.push(
-          import_actions2.entityActions.modifyEntityField({
-            id: options.parent.resource.id,
-            type: options.parent.resource.type,
-            value: resource.ref(),
-            key: options.parent.property
-          })
-        );
-      } else {
-        afterActions.push(
-          import_actions2.entityActions.addReference({
-            id: options.parent.resource.id,
-            type: options.parent.resource.type,
-            reference: resource.ref(),
-            key: options.parent.property,
-            index: options.parent.atIndex
-          })
-        );
+    for (const resource of allResources) {
+      if (options?.parent) {
+        if (options.parent.property === "start" || options.parent.property === "target") {
+          afterActions.push(
+            import_actions2.entityActions.modifyEntityField({
+              id: options.parent.resource.id,
+              type: options.parent.resource.type,
+              value: resource.ref(),
+              key: options.parent.property
+            })
+          );
+        } else {
+          afterActions.push(
+            import_actions2.entityActions.addReference({
+              id: options.parent.resource.id,
+              type: options.parent.resource.type,
+              reference: resource.ref(),
+              key: options.parent.property,
+              index: options.parent.atIndex
+            })
+          );
+        }
       }
     }
     const result = runtime.commit(afterActions);
@@ -616,7 +643,10 @@ var Creator = class {
       if (foundDefinition.sideEffects) {
         for (const sideEffect of foundDefinition.sideEffects) {
           if (sideEffect.run) {
-            await sideEffect.run(result, { vault: this.vault, options });
+            const allResults = Array.isArray(result) ? result : [result];
+            for (const item of allResults) {
+              await sideEffect.run(item, { vault: this.vault, options });
+            }
           }
         }
       }
@@ -624,3 +654,8 @@ var Creator = class {
     return result;
   }
 };
+
+// src/creator-register.ts
+function defineCreator(options) {
+  return options;
+}

package/dist/index.d.cts

@@ -1,6 +1,7 @@
-import * as _iiif_presentation_3 from '@iiif/presentation-3';
-import { Reference, SpecificResource } from '@iiif/presentation-3';
 import { Vault, Entities } from '@iiif/helpers/vault';
+import * as _iiif_presentation_3 from '@iiif/presentation-3';
+import { Reference, SpecificResource, LinkingProperties, StructuralProperties, TechnicalProperties, DescriptiveProperties, Annotation, NavPlaceExtension } from '@iiif/presentation-3';
+import { resources } from '@manifest-editor/editor-api';
 import { ReactNode } from 'react';
 
 declare class ReferencedResource {
@@ -124,8 +125,31 @@ declare class CreatorInstance implements CreatorFunctionContext {
     generateId(type: string, parent?: Reference | ReferencedResource): string;
     ref(idOrRef: string | Reference): ReferencedResource;
     embed(data: any): CreatorResource;
-    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<CreatorResource>;
+    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<any>;
+}
+
+declare function defineCreator<const Payload = any, const ID = Readonly<string>, const ResourceType extends AllAvailableParentTypes = never, const AdditionalResourceTypes extends Array<AllAvailableParentTypes> = [], const AllResourceTypes = [ResourceType, ...AdditionalResourceTypes], const SupportsParentTypes extends Array<AllAvailableParentTypes> = AllParentTypes, const SupportsParentFields extends Array<AllProperties> = [], const CreateReturnType = any>(options: SpecificCreatorDefinition<Payload, ID, ResourceType, AdditionalResourceTypes, AllResourceTypes, SupportsParentTypes, SupportsParentFields, CreateReturnType>): SpecificCreatorDefinition<Payload, ID, ResourceType, AdditionalResourceTypes, AllResourceTypes, SupportsParentTypes, SupportsParentFields, CreateReturnType>;
+declare namespace IIIFManifestEditor {
+    interface CreatorDefinitions {
+    }
 }
+type ExtractCreatorGenerics<T extends CreatorDefinition> = T extends SpecificCreatorDefinition<infer Payload, infer ID, infer ResourceType, infer AdditionalResourceTypes, infer AllResourceTypes, infer SupportsParentTypes, infer SupportsParentFields, infer CreateReturnType> ? {
+    Payload: Payload;
+    ID: ID;
+    ResourceType: ResourceType;
+    AdditionalResourceTypes: AdditionalResourceTypes;
+    AllResourceTypes: AllResourceTypes;
+    SupportsParentTypes: SupportsParentTypes;
+    SupportsParentFields: SupportsParentFields;
+    CreateReturnType: CreateReturnType;
+} : never;
+type CreatorSupportsParentTypes<T, Type extends AllAvailableParentTypes> = T extends CreatorDefinition ? ExtractCreatorGenerics<T>["SupportsParentTypes"] extends never ? false : HelperInArray<Type, ExtractCreatorGenerics<T>["SupportsParentTypes"]> : false;
+type CreatorSupportsParentFields<T, Field extends AllProperties> = T extends CreatorDefinition ? ExtractCreatorGenerics<T>["SupportsParentFields"] extends never ? false : HelperInArray<Field, ExtractCreatorGenerics<T>["SupportsParentFields"]> : false;
+type CreatorSupportsParent<T, Type extends AllAvailableParentTypes, Field extends AllProperties> = T extends CreatorDefinition ? CreatorSupportsParentTypes<T, Type> extends true ? CreatorSupportsParentFields<T, Field> extends true ? true : false : false : false;
+type HelperInArray<ToFind, Array extends readonly any[]> = Array extends readonly [infer Head, ...infer Tail] ? Head extends ToFind ? true : HelperInArray<ToFind, Tail> : false;
+type CreatorDefinitionFilterByParent<Type extends AllAvailableParentTypes, Field extends AllProperties = AllProperties, CD extends IIIFManifestEditor.CreatorDefinitions = IIIFManifestEditor.CreatorDefinitions> = {
+    [K in keyof CD]: CreatorSupportsParent<CD[K], Type, Field> extends true ? CD[K] : never;
+}[keyof CD];
 
 interface CreatorContext<T = any> {
     vault: Vault;
@@ -133,17 +157,20 @@ interface CreatorContext<T = any> {
     validate: (payload: T) => Promise<boolean> | boolean;
     runCreate: (payload: T) => void;
 }
+type ResolvedCreatorReturn<T extends CreatorDefinition> = Awaited<ExtractCreatorGenerics<T>["CreateReturnType"]> extends any[] ? CreatorResource[] : CreatorResource;
 interface CreatorFunctionContext {
     options: CreatorOptions;
     ref(idOrRef: string | Reference): ReferencedResource;
     embed(data: any): CreatorResource;
-    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<CreatorResource>;
+    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<CreatorResource | CreatorResource[]>;
+    create<Definition extends CreatorDefinition = any>(definition: Definition["id"], payload: GetCreatorPayload<Definition>, options?: Partial<CreatorOptions>): Promise<ResolvedCreatorReturn<Definition>>;
     generateId(type: string, parent?: Reference | ReferencedResource): string;
     getParent(): Reference | undefined;
     getTarget(): SpecificResource | Reference | undefined;
     getParentResource(): SpecificResource | undefined;
     getPreviewVault(): Vault;
 }
+type GetCreatorPayload<T extends CreatorDefinition> = T extends CreatorDefinition<infer Payload> ? Payload : never;
 interface CreatorParent {
     resource: Reference;
     property: string;
@@ -155,20 +182,34 @@ interface CreatorOptions {
     parent?: CreatorParent;
     initialData?: any;
 }
-interface CreatorDefinition {
-    id: string;
+type AllAvailableParentTypes = keyof typeof resources.supported;
+type GetSupportedResourceFields<Resource extends AllAvailableParentTypes> = {} & (typeof resources.supported)[Resource]["allowed"][number];
+type AllProperties = ({} & keyof LinkingProperties) | ({} & keyof StructuralProperties<any>) | ({} & keyof TechnicalProperties) | ({} & keyof DescriptiveProperties) | ({} & keyof Annotation) | ({} & keyof NavPlaceExtension);
+type AllParentTypes = [
+    "Collection",
+    "Manifest",
+    "Canvas",
+    "Annotation",
+    "AnnotationPage",
+    "Range",
+    "AnnotationCollection",
+    "ContentResource",
+    "Agent"
+];
+interface SpecificCreatorDefinition<Payload = any, ID = Readonly<string>, ResourceType extends AllAvailableParentTypes = never, AdditionalResourceTypes extends Array<AllAvailableParentTypes> = [], AllResourceTypes = [ResourceType, ...AdditionalResourceTypes], SupportsParentTypes extends Array<AllAvailableParentTypes> = AllParentTypes, SupportsParentFields extends Array<AllProperties> = [], CreateReturnType = any | Promise<any> | any[] | Promise<any[]>> {
+    readonly id: ID;
     label: string;
     summary?: string;
     icon?: any;
     dependencies?: string[];
     tags?: string[];
-    create: (payload: any, ctx: CreatorInstance) => any | Promise<any>;
-    validate?: (payload: any, vault: Vault) => void | Promise<void>;
-    render?: (ctx: CreatorContext) => ReactNode;
-    renderCanvas?: (ctx: CreatorContext) => ReactNode | null;
-    renderModal?: (ctx: CreatorContext) => ReactNode;
-    resourceType: string;
-    additionalTypes?: string[];
+    create: (payload: Payload, ctx: CreatorInstance) => CreateReturnType;
+    validate?: (payload: Payload, vault: Vault) => void | Promise<void>;
+    render?: (ctx: CreatorContext<Payload>) => ReactNode;
+    renderCanvas?: (ctx: CreatorContext<Payload>) => ReactNode | null;
+    renderModal?: (ctx: CreatorContext<Payload>) => ReactNode;
+    resourceType: ResourceType;
+    additionalTypes?: AdditionalResourceTypes;
     resourceFields: string[];
     embeddedResources?: string[];
     staticFields?: Record<string, any>;
@@ -176,14 +217,15 @@ interface CreatorDefinition {
     hiddenModal?: boolean;
     supports: {
         initialData?: boolean;
-        parentTypes?: string[];
-        parentFields?: string[];
+        parentTypes?: SupportsParentTypes;
+        parentFields?: SupportsParentFields;
         parentFieldMap?: Record<string, string[]>;
         custom?: (parent: CreatorParent, vault: Vault) => boolean;
         disallowPainting?: boolean;
     };
     sideEffects?: Array<CreatorSideEffect>;
 }
+type CreatorDefinition<Payload = any> = SpecificCreatorDefinition<Payload, any, any, any, any, any, any>;
 interface CreatorSideEffect {
     run?: (result: any, ctx: {
         options: CreatorOptions;
@@ -213,7 +255,7 @@ declare class Creator {
     previewVault: Vault;
     constructor(vault: Vault, configs: CreatorDefinition[], previewVault?: Vault);
     matchBasedOnResource(resource: CreatableResource): CreatorDefinition[];
-    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<Reference>;
+    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<Reference | Reference[]>;
 }
 
 declare function resolveType(type: string): keyof Entities;
@@ -222,5 +264,9 @@ declare function randomId(): string;
 declare function matchBasedOnResource(resource: CreatableResource, list: CreatorDefinition[], options: {
     vault: Vault;
 }): CreatorDefinition[];
+declare function creatorHelper<const ResourceType extends AllAvailableParentTypes, const Parent extends {
+    id: string;
+    type: ResourceType;
+}, const ResourceField extends GetSupportedResourceFields<ResourceType>, const CID extends CreatorDefinitionFilterByParent<ResourceType, ResourceField>["id"], Payload = GetCreatorPayload<IIIFManifestEditor.CreatorDefinitions[CID]>, Return = ResolvedCreatorReturn<IIIFManifestEditor.CreatorDefinitions[CID]>>(ctx: CreatorFunctionContext, parent: Parent | ResourceType, property: ResourceField, definition: CID): (payload: Payload, options?: Partial<CreatorOptions>) => Promise<Return>;
 
-export { type CreatableResource, Creator, type CreatorContext, type CreatorDefinition, type CreatorFunctionContext, type CreatorOptions, CreatorResource, type CreatorSideEffect, getEmptyType, matchBasedOnResource, randomId, resolveType };
+export { type AllAvailableParentTypes, type AllParentTypes, type AllProperties, type CreatableResource, Creator, type CreatorContext, type CreatorDefinition, type CreatorDefinitionFilterByParent, type CreatorFunctionContext, type CreatorOptions, CreatorResource, type CreatorSideEffect, type ExtractCreatorGenerics, type GetCreatorPayload, type GetSupportedResourceFields, IIIFManifestEditor, type ResolvedCreatorReturn, type SpecificCreatorDefinition, creatorHelper, defineCreator, getEmptyType, matchBasedOnResource, randomId, resolveType };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-import * as _iiif_presentation_3 from '@iiif/presentation-3';
-import { Reference, SpecificResource } from '@iiif/presentation-3';
 import { Vault, Entities } from '@iiif/helpers/vault';
+import * as _iiif_presentation_3 from '@iiif/presentation-3';
+import { Reference, SpecificResource, LinkingProperties, StructuralProperties, TechnicalProperties, DescriptiveProperties, Annotation, NavPlaceExtension } from '@iiif/presentation-3';
+import { resources } from '@manifest-editor/editor-api';
 import { ReactNode } from 'react';
 
 declare class ReferencedResource {
@@ -124,8 +125,31 @@ declare class CreatorInstance implements CreatorFunctionContext {
     generateId(type: string, parent?: Reference | ReferencedResource): string;
     ref(idOrRef: string | Reference): ReferencedResource;
     embed(data: any): CreatorResource;
-    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<CreatorResource>;
+    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<any>;
+}
+
+declare function defineCreator<const Payload = any, const ID = Readonly<string>, const ResourceType extends AllAvailableParentTypes = never, const AdditionalResourceTypes extends Array<AllAvailableParentTypes> = [], const AllResourceTypes = [ResourceType, ...AdditionalResourceTypes], const SupportsParentTypes extends Array<AllAvailableParentTypes> = AllParentTypes, const SupportsParentFields extends Array<AllProperties> = [], const CreateReturnType = any>(options: SpecificCreatorDefinition<Payload, ID, ResourceType, AdditionalResourceTypes, AllResourceTypes, SupportsParentTypes, SupportsParentFields, CreateReturnType>): SpecificCreatorDefinition<Payload, ID, ResourceType, AdditionalResourceTypes, AllResourceTypes, SupportsParentTypes, SupportsParentFields, CreateReturnType>;
+declare namespace IIIFManifestEditor {
+    interface CreatorDefinitions {
+    }
 }
+type ExtractCreatorGenerics<T extends CreatorDefinition> = T extends SpecificCreatorDefinition<infer Payload, infer ID, infer ResourceType, infer AdditionalResourceTypes, infer AllResourceTypes, infer SupportsParentTypes, infer SupportsParentFields, infer CreateReturnType> ? {
+    Payload: Payload;
+    ID: ID;
+    ResourceType: ResourceType;
+    AdditionalResourceTypes: AdditionalResourceTypes;
+    AllResourceTypes: AllResourceTypes;
+    SupportsParentTypes: SupportsParentTypes;
+    SupportsParentFields: SupportsParentFields;
+    CreateReturnType: CreateReturnType;
+} : never;
+type CreatorSupportsParentTypes<T, Type extends AllAvailableParentTypes> = T extends CreatorDefinition ? ExtractCreatorGenerics<T>["SupportsParentTypes"] extends never ? false : HelperInArray<Type, ExtractCreatorGenerics<T>["SupportsParentTypes"]> : false;
+type CreatorSupportsParentFields<T, Field extends AllProperties> = T extends CreatorDefinition ? ExtractCreatorGenerics<T>["SupportsParentFields"] extends never ? false : HelperInArray<Field, ExtractCreatorGenerics<T>["SupportsParentFields"]> : false;
+type CreatorSupportsParent<T, Type extends AllAvailableParentTypes, Field extends AllProperties> = T extends CreatorDefinition ? CreatorSupportsParentTypes<T, Type> extends true ? CreatorSupportsParentFields<T, Field> extends true ? true : false : false : false;
+type HelperInArray<ToFind, Array extends readonly any[]> = Array extends readonly [infer Head, ...infer Tail] ? Head extends ToFind ? true : HelperInArray<ToFind, Tail> : false;
+type CreatorDefinitionFilterByParent<Type extends AllAvailableParentTypes, Field extends AllProperties = AllProperties, CD extends IIIFManifestEditor.CreatorDefinitions = IIIFManifestEditor.CreatorDefinitions> = {
+    [K in keyof CD]: CreatorSupportsParent<CD[K], Type, Field> extends true ? CD[K] : never;
+}[keyof CD];
 
 interface CreatorContext<T = any> {
     vault: Vault;
@@ -133,17 +157,20 @@ interface CreatorContext<T = any> {
     validate: (payload: T) => Promise<boolean> | boolean;
     runCreate: (payload: T) => void;
 }
+type ResolvedCreatorReturn<T extends CreatorDefinition> = Awaited<ExtractCreatorGenerics<T>["CreateReturnType"]> extends any[] ? CreatorResource[] : CreatorResource;
 interface CreatorFunctionContext {
     options: CreatorOptions;
     ref(idOrRef: string | Reference): ReferencedResource;
     embed(data: any): CreatorResource;
-    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<CreatorResource>;
+    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<CreatorResource | CreatorResource[]>;
+    create<Definition extends CreatorDefinition = any>(definition: Definition["id"], payload: GetCreatorPayload<Definition>, options?: Partial<CreatorOptions>): Promise<ResolvedCreatorReturn<Definition>>;
     generateId(type: string, parent?: Reference | ReferencedResource): string;
     getParent(): Reference | undefined;
     getTarget(): SpecificResource | Reference | undefined;
     getParentResource(): SpecificResource | undefined;
     getPreviewVault(): Vault;
 }
+type GetCreatorPayload<T extends CreatorDefinition> = T extends CreatorDefinition<infer Payload> ? Payload : never;
 interface CreatorParent {
     resource: Reference;
     property: string;
@@ -155,20 +182,34 @@ interface CreatorOptions {
     parent?: CreatorParent;
     initialData?: any;
 }
-interface CreatorDefinition {
-    id: string;
+type AllAvailableParentTypes = keyof typeof resources.supported;
+type GetSupportedResourceFields<Resource extends AllAvailableParentTypes> = {} & (typeof resources.supported)[Resource]["allowed"][number];
+type AllProperties = ({} & keyof LinkingProperties) | ({} & keyof StructuralProperties<any>) | ({} & keyof TechnicalProperties) | ({} & keyof DescriptiveProperties) | ({} & keyof Annotation) | ({} & keyof NavPlaceExtension);
+type AllParentTypes = [
+    "Collection",
+    "Manifest",
+    "Canvas",
+    "Annotation",
+    "AnnotationPage",
+    "Range",
+    "AnnotationCollection",
+    "ContentResource",
+    "Agent"
+];
+interface SpecificCreatorDefinition<Payload = any, ID = Readonly<string>, ResourceType extends AllAvailableParentTypes = never, AdditionalResourceTypes extends Array<AllAvailableParentTypes> = [], AllResourceTypes = [ResourceType, ...AdditionalResourceTypes], SupportsParentTypes extends Array<AllAvailableParentTypes> = AllParentTypes, SupportsParentFields extends Array<AllProperties> = [], CreateReturnType = any | Promise<any> | any[] | Promise<any[]>> {
+    readonly id: ID;
     label: string;
     summary?: string;
     icon?: any;
     dependencies?: string[];
     tags?: string[];
-    create: (payload: any, ctx: CreatorInstance) => any | Promise<any>;
-    validate?: (payload: any, vault: Vault) => void | Promise<void>;
-    render?: (ctx: CreatorContext) => ReactNode;
-    renderCanvas?: (ctx: CreatorContext) => ReactNode | null;
-    renderModal?: (ctx: CreatorContext) => ReactNode;
-    resourceType: string;
-    additionalTypes?: string[];
+    create: (payload: Payload, ctx: CreatorInstance) => CreateReturnType;
+    validate?: (payload: Payload, vault: Vault) => void | Promise<void>;
+    render?: (ctx: CreatorContext<Payload>) => ReactNode;
+    renderCanvas?: (ctx: CreatorContext<Payload>) => ReactNode | null;
+    renderModal?: (ctx: CreatorContext<Payload>) => ReactNode;
+    resourceType: ResourceType;
+    additionalTypes?: AdditionalResourceTypes;
     resourceFields: string[];
     embeddedResources?: string[];
     staticFields?: Record<string, any>;
@@ -176,14 +217,15 @@ interface CreatorDefinition {
     hiddenModal?: boolean;
     supports: {
         initialData?: boolean;
-        parentTypes?: string[];
-        parentFields?: string[];
+        parentTypes?: SupportsParentTypes;
+        parentFields?: SupportsParentFields;
         parentFieldMap?: Record<string, string[]>;
         custom?: (parent: CreatorParent, vault: Vault) => boolean;
         disallowPainting?: boolean;
     };
     sideEffects?: Array<CreatorSideEffect>;
 }
+type CreatorDefinition<Payload = any> = SpecificCreatorDefinition<Payload, any, any, any, any, any, any>;
 interface CreatorSideEffect {
     run?: (result: any, ctx: {
         options: CreatorOptions;
@@ -213,7 +255,7 @@ declare class Creator {
     previewVault: Vault;
     constructor(vault: Vault, configs: CreatorDefinition[], previewVault?: Vault);
     matchBasedOnResource(resource: CreatableResource): CreatorDefinition[];
-    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<Reference>;
+    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<Reference | Reference[]>;
 }
 
 declare function resolveType(type: string): keyof Entities;
@@ -222,5 +264,9 @@ declare function randomId(): string;
 declare function matchBasedOnResource(resource: CreatableResource, list: CreatorDefinition[], options: {
     vault: Vault;
 }): CreatorDefinition[];
+declare function creatorHelper<const ResourceType extends AllAvailableParentTypes, const Parent extends {
+    id: string;
+    type: ResourceType;
+}, const ResourceField extends GetSupportedResourceFields<ResourceType>, const CID extends CreatorDefinitionFilterByParent<ResourceType, ResourceField>["id"], Payload = GetCreatorPayload<IIIFManifestEditor.CreatorDefinitions[CID]>, Return = ResolvedCreatorReturn<IIIFManifestEditor.CreatorDefinitions[CID]>>(ctx: CreatorFunctionContext, parent: Parent | ResourceType, property: ResourceField, definition: CID): (payload: Payload, options?: Partial<CreatorOptions>) => Promise<Return>;
 
-export { type CreatableResource, Creator, type CreatorContext, type CreatorDefinition, type CreatorFunctionContext, type CreatorOptions, CreatorResource, type CreatorSideEffect, getEmptyType, matchBasedOnResource, randomId, resolveType };
+export { type AllAvailableParentTypes, type AllParentTypes, type AllProperties, type CreatableResource, Creator, type CreatorContext, type CreatorDefinition, type CreatorDefinitionFilterByParent, type CreatorFunctionContext, type CreatorOptions, CreatorResource, type CreatorSideEffect, type ExtractCreatorGenerics, type GetCreatorPayload, type GetSupportedResourceFields, IIIFManifestEditor, type ResolvedCreatorReturn, type SpecificCreatorDefinition, creatorHelper, defineCreator, getEmptyType, matchBasedOnResource, randomId, resolveType };

package/dist/index.js

@@ -7,11 +7,13 @@ var __publicField = (obj, key, value) => {
 
 // src/Creator.ts
 import { Vault } from "@iiif/helpers/vault";
+import { entityActions } from "@iiif/helpers/vault/actions";
 
 // src/CreatorRuntime.ts
-import { importEntities, addMappings, batchActions } from "@iiif/helpers/vault/actions";
+import { addMappings, batchActions, importEntities } from "@iiif/helpers/vault/actions";
 
 // src/CreatorResource.ts
+import { HAS_PART, PART_OF } from "@iiif/parser";
 import { references } from "@manifest-editor/editor-api";
 
 // src/ReferencedResource.ts
@@ -134,10 +136,7 @@ function matchBasedOnResource(resource, list, options) {
         continue;
       }
       if (def.supports.custom) {
-        const isValid = def.supports.custom(
-          { property, resource: parent, atIndex: resource.index },
-          options.vault
-        );
+        const isValid = def.supports.custom({ property, resource: parent, atIndex: resource.index }, options.vault);
         if (!isValid) {
           continue;
         }
@@ -155,9 +154,20 @@ function matchBasedOnResource(resource, list, options) {
   }
   return supported;
 }
+function creatorHelper(ctx, parent, property, definition) {
+  return (payload, options = {}) => {
+    if (typeof parent !== "string") {
+      options.parent = {
+        property,
+        resource: parent,
+        atIndex: options?.parent?.atIndex
+      };
+    }
+    return ctx.create(definition, payload, options);
+  };
+}
 
 // src/CreatorResource.ts
-import { HAS_PART, PART_OF } from "@iiif/parser";
 var CreatorResource = class _CreatorResource {
   constructor(data, vault) {
     __publicField(this, "resource");
@@ -191,7 +201,6 @@ var CreatorResource = class _CreatorResource {
           const rangeRef = new ReferencedResource(range, vault);
           newRange.push(rangeRef);
           data[key] = rangeRef;
-          continue;
         }
         data[key] = newRange;
         continue;
@@ -468,13 +477,25 @@ var CreatorRuntime = class {
     this.payload = payload;
     this.configs = createConfigs;
     this.options = {
-      targetType: (options || {}).targetType || definition.resourceType,
+      targetType: options?.targetType || definition.resourceType,
       ...options || {}
     };
   }
   async run() {
     const instance = new CreatorInstance(this.vault, this.options, this.configs, this.previewVault);
     const result = await this.definition.create(this.payload, instance);
+    if (Array.isArray(result)) {
+      const results = [];
+      for (const item of result) {
+        if (item instanceof CreatorResource) {
+          results.push(item);
+        } else {
+          results.push(new CreatorResource(item, this.vault));
+        }
+      }
+      this.resource = results;
+      return this.resource;
+    }
     if (result instanceof CreatorResource) {
       this.resource = result;
     } else {
@@ -486,26 +507,29 @@ var CreatorRuntime = class {
     if (!this.resource) {
       return [];
     }
+    const allResources = Array.isArray(this.resource) ? this.resource : [this.resource];
     const actions = [];
     const resources = {};
     const mapping = {};
-    if (this.options.parent) {
-      this.resource.setPartOf(this.options.parent.resource.id);
-    }
-    const embedded = this.resource.getAllEmbeddedResources();
-    const allItems = [...embedded, this.resource];
-    for (const item of allItems) {
-      const resource = item.getVaultResource();
-      if (!resource.type || !resource.id) {
-        continue;
+    for (const resource of allResources) {
+      if (this.options.parent) {
+        resource.setPartOf(this.options.parent.resource.id);
       }
-      const type = resolveType(resource.type);
-      resources[type] = resources[type] ? resources[type] : {};
-      resources[type][resource.id] = resource;
-      mapping[resource.id] = type;
+      const embedded = resource.getAllEmbeddedResources();
+      const allItems = [...embedded, resource];
+      for (const item of allItems) {
+        const resource2 = item.getVaultResource();
+        if (!resource2.type || !resource2.id) {
+          continue;
+        }
+        const type = resolveType(resource2.type);
+        resources[type] = resources[type] ? resources[type] : {};
+        resources[type][resource2.id] = resource2;
+        mapping[resource2.id] = type;
+      }
+      actions.push(importEntities({ entities: resources }));
+      actions.push(addMappings({ mapping }));
     }
-    actions.push(importEntities({ entities: resources }));
-    actions.push(addMappings({ mapping }));
     return actions;
   }
   commit(afterActions = []) {
@@ -514,12 +538,14 @@ var CreatorRuntime = class {
     }
     const actions = this.getActions();
     this.vault.dispatch(batchActions({ actions: [...actions, ...afterActions] }));
+    if (Array.isArray(this.resource)) {
+      return this.resource.map((resource) => resource.ref());
+    }
     return this.resource.ref();
   }
 };
 
 // src/Creator.ts
-import { entityActions } from "@iiif/helpers/vault/actions";
 var Creator = class {
   constructor(vault, configs, previewVault) {
     __publicField(this, "configs");
@@ -530,11 +556,7 @@ var Creator = class {
     this.previewVault = previewVault || new Vault();
   }
   matchBasedOnResource(resource) {
-    return matchBasedOnResource(
-      resource,
-      this.configs || [],
-      { vault: this.vault }
-    );
+    return matchBasedOnResource(resource, this.configs || [], { vault: this.vault });
   }
   async create(definition, payload, options) {
     const foundDefinition = this.configs.find((t) => t.id === definition);
@@ -568,28 +590,31 @@ var Creator = class {
       }
     }
     const runtime = new CreatorRuntime(this.vault, foundDefinition, payload, this.configs, this.previewVault, options);
-    const resource = await runtime.run();
+    const run = await runtime.run();
+    const allResources = Array.isArray(run) ? run : [run];
     const afterActions = [];
-    if (options?.parent) {
-      if (options.parent.property === "start" || options.parent.property === "target") {
-        afterActions.push(
-          entityActions.modifyEntityField({
-            id: options.parent.resource.id,
-            type: options.parent.resource.type,
-            value: resource.ref(),
-            key: options.parent.property
-          })
-        );
-      } else {
-        afterActions.push(
-          entityActions.addReference({
-            id: options.parent.resource.id,
-            type: options.parent.resource.type,
-            reference: resource.ref(),
-            key: options.parent.property,
-            index: options.parent.atIndex
-          })
-        );
+    for (const resource of allResources) {
+      if (options?.parent) {
+        if (options.parent.property === "start" || options.parent.property === "target") {
+          afterActions.push(
+            entityActions.modifyEntityField({
+              id: options.parent.resource.id,
+              type: options.parent.resource.type,
+              value: resource.ref(),
+              key: options.parent.property
+            })
+          );
+        } else {
+          afterActions.push(
+            entityActions.addReference({
+              id: options.parent.resource.id,
+              type: options.parent.resource.type,
+              reference: resource.ref(),
+              key: options.parent.property,
+              index: options.parent.atIndex
+            })
+          );
+        }
       }
     }
     const result = runtime.commit(afterActions);
@@ -597,7 +622,10 @@ var Creator = class {
       if (foundDefinition.sideEffects) {
         for (const sideEffect of foundDefinition.sideEffects) {
           if (sideEffect.run) {
-            await sideEffect.run(result, { vault: this.vault, options });
+            const allResults = Array.isArray(result) ? result : [result];
+            for (const item of allResults) {
+              await sideEffect.run(item, { vault: this.vault, options });
+            }
           }
         }
       }
@@ -605,9 +633,16 @@ var Creator = class {
     return result;
   }
 };
+
+// src/creator-register.ts
+function defineCreator(options) {
+  return options;
+}
 export {
   Creator,
   CreatorResource,
+  creatorHelper,
+  defineCreator,
   getEmptyType,
   matchBasedOnResource,
   randomId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manifest-editor/creator-api",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "type": "module",
   "bugs": "https://github.com/digirati-co-uk/iiif-manifest-editor/issues",
   "repository": {
@@ -43,10 +43,10 @@
   },
   "dependencies": {
     "@iiif/helpers": "^1.3.1",
-    "@iiif/parser": "^2.1.7",
+    "@iiif/parser": "^2.1.8",
     "@iiif/presentation-3": "^2.2.3",
     "@iiif/presentation-3-normalized": "^0.9.7",
-    "@manifest-editor/editor-api": "1.3.0",
+    "@manifest-editor/editor-api": "1.4.0",
     "polygon-editor": "^0.0.6",
     "react-iiif-vault": "^1.2.1"
   },
@@ -59,5 +59,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "deba5190f58c11b91383eacd79715607ba5b8d24"
+  "gitHead": "4ca76024a42ec30c958f476a6fcd8d10592c12d3"
 }