@manifest-editor/creator-api 1.4.3 → 2.0.1-next.0.ede7d58

package/dist/index.d.cts

@@ -1,273 +1,315 @@
-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';
+import { Entities, Vault } from "@iiif/helpers/vault";
+import * as _iiif_presentation_329 from "@iiif/presentation-3";
+import { Annotation, DescriptiveProperties, LinkingProperties, NavPlaceExtension, Reference, SpecificResource, StructuralProperties, TechnicalProperties } from "@iiif/presentation-3";
+import { resources } from "@manifest-editor/editor-api";
+import { ReactNode } from "react";
+import { SupportedSelector } from "@iiif/helpers";
 
+//#region src/ReferencedResource.d.ts
 declare class ReferencedResource {
-    vault: Vault;
-    original: Reference | SpecificResource;
-    reference: Reference;
-    resource: SpecificResource;
-    constructor(reference: Reference | SpecificResource, vault: Vault);
-    ref(): {
-        type: string;
-        id: string;
-    };
-    specificResource(): {
-        created?: string | undefined;
-        generated?: string | undefined;
-        modified?: string | undefined;
-        creator?: _iiif_presentation_3.Creator | undefined;
-        generator?: _iiif_presentation_3.Creator | undefined;
-        audience?: (_iiif_presentation_3.Audience | _iiif_presentation_3.Audience[]) | undefined;
-        accessibility?: string | string[] | undefined;
-        motivation?: (_iiif_presentation_3.AnyMotivation | _iiif_presentation_3.AnyMotivation[]) | undefined;
-        rights?: string | string[] | undefined;
-        canonical?: string | undefined;
-        via?: string | string[] | undefined;
-        role?: string | undefined;
-        id?: string | undefined;
-        type: "SpecificResource";
-        state?: (_iiif_presentation_3.State | _iiif_presentation_3.State[]) | undefined;
-        purpose?: (_iiif_presentation_3.AnyMotivation | _iiif_presentation_3.AnyMotivation[]) | undefined;
-        source?: any;
-        selector?: (_iiif_presentation_3.Selector | _iiif_presentation_3.Selector[]) | undefined;
-        styleClass?: string | undefined;
-        renderedVia?: (_iiif_presentation_3.Agent | _iiif_presentation_3.Agent[]) | undefined;
-        scope?: _iiif_presentation_3.LinkedResource;
-    };
-    optionalSpecificResource(): {
-        type: string;
-        id: string;
-    } | {
-        source: {
-            id: any;
-            type: any;
-        };
-        created?: string | undefined;
-        generated?: string | undefined;
-        modified?: string | undefined;
-        creator?: _iiif_presentation_3.Creator | undefined;
-        generator?: _iiif_presentation_3.Creator | undefined;
-        audience?: (_iiif_presentation_3.Audience | _iiif_presentation_3.Audience[]) | undefined;
-        accessibility?: string | string[] | undefined;
-        motivation?: (_iiif_presentation_3.AnyMotivation | _iiif_presentation_3.AnyMotivation[]) | undefined;
-        rights?: string | string[] | undefined;
-        canonical?: string | undefined;
-        via?: string | string[] | undefined;
-        role?: string | undefined;
-        id?: string | undefined;
-        type: "SpecificResource";
-        state?: (_iiif_presentation_3.State | _iiif_presentation_3.State[]) | undefined;
-        purpose?: (_iiif_presentation_3.AnyMotivation | _iiif_presentation_3.AnyMotivation[]) | undefined;
-        selector?: (_iiif_presentation_3.Selector | _iiif_presentation_3.Selector[]) | undefined;
-        styleClass?: string | undefined;
-        renderedVia?: (_iiif_presentation_3.Agent | _iiif_presentation_3.Agent[]) | undefined;
-        scope?: _iiif_presentation_3.LinkedResource;
+  vault: Vault;
+  original: Reference | SpecificResource;
+  reference: Reference;
+  resource: SpecificResource;
+  constructor(reference: Reference | SpecificResource, vault: Vault);
+  ref(): {
+    type: string;
+    id: string;
+  };
+  specificResource(): {
+    created?: string | undefined;
+    generated?: string | undefined;
+    modified?: string | undefined;
+    creator?: _iiif_presentation_329.Creator | undefined;
+    generator?: _iiif_presentation_329.Creator | undefined;
+    audience?: (_iiif_presentation_329.Audience | _iiif_presentation_329.Audience[]) | undefined;
+    accessibility?: string | string[] | undefined;
+    motivation?: (_iiif_presentation_329.AnyMotivation | _iiif_presentation_329.AnyMotivation[]) | undefined;
+    rights?: string | string[] | undefined;
+    canonical?: string | undefined;
+    via?: string | string[] | undefined;
+    role?: string | undefined;
+    id?: string | undefined;
+    type: "SpecificResource";
+    state?: (_iiif_presentation_329.State | _iiif_presentation_329.State[]) | undefined;
+    purpose?: (_iiif_presentation_329.AnyMotivation | _iiif_presentation_329.AnyMotivation[]) | undefined;
+    source?: any;
+    selector?: (_iiif_presentation_329.Selector | _iiif_presentation_329.Selector[]) | undefined;
+    styleClass?: string | undefined;
+    renderedVia?: (_iiif_presentation_329.Agent | _iiif_presentation_329.Agent[]) | undefined;
+    scope?: _iiif_presentation_329.LinkedResource;
+  };
+  optionalSpecificResource(): {
+    type: string;
+    id: string;
+  } | {
+    source: {
+      id: any;
+      type: any;
     };
-    get(): any;
+    created?: string | undefined;
+    generated?: string | undefined;
+    modified?: string | undefined;
+    creator?: _iiif_presentation_329.Creator | undefined;
+    generator?: _iiif_presentation_329.Creator | undefined;
+    audience?: (_iiif_presentation_329.Audience | _iiif_presentation_329.Audience[]) | undefined;
+    accessibility?: string | string[] | undefined;
+    motivation?: (_iiif_presentation_329.AnyMotivation | _iiif_presentation_329.AnyMotivation[]) | undefined;
+    rights?: string | string[] | undefined;
+    canonical?: string | undefined;
+    via?: string | string[] | undefined;
+    role?: string | undefined;
+    id?: string | undefined;
+    type: "SpecificResource";
+    state?: (_iiif_presentation_329.State | _iiif_presentation_329.State[]) | undefined;
+    purpose?: (_iiif_presentation_329.AnyMotivation | _iiif_presentation_329.AnyMotivation[]) | undefined;
+    selector?: (_iiif_presentation_329.Selector | _iiif_presentation_329.Selector[]) | undefined;
+    styleClass?: string | undefined;
+    renderedVia?: (_iiif_presentation_329.Agent | _iiif_presentation_329.Agent[]) | undefined;
+    scope?: _iiif_presentation_329.LinkedResource;
+  };
+  get(): any;
 }
-
+//#endregion
+//#region src/CreatorResource.d.ts
 declare class CreatorResource {
-    resource: any;
-    warnings: string[];
-    errors: string[];
-    partOf: any;
-    references: ReferencedResource[];
-    embedded: CreatorResource[];
-    vault: Vault;
-    specificResource?: SpecificResource;
-    constructor(inputData: any, vault: Vault);
-    get(): any;
-    ref(): {
-        created?: string | undefined;
-        generated?: string | undefined;
-        modified?: string | undefined;
-        creator?: _iiif_presentation_3.Creator | undefined;
-        generator?: _iiif_presentation_3.Creator | undefined;
-        audience?: (_iiif_presentation_3.Audience | _iiif_presentation_3.Audience[]) | undefined;
-        accessibility?: string | string[] | undefined;
-        motivation?: (_iiif_presentation_3.AnyMotivation | _iiif_presentation_3.AnyMotivation[]) | undefined;
-        rights?: string | string[] | undefined;
-        canonical?: string | undefined;
-        via?: string | string[] | undefined;
-        role?: string | undefined;
-        id?: string | undefined;
-        type: "SpecificResource";
-        state?: (_iiif_presentation_3.State | _iiif_presentation_3.State[]) | undefined;
-        purpose?: (_iiif_presentation_3.AnyMotivation | _iiif_presentation_3.AnyMotivation[]) | undefined;
-        source?: any;
-        selector?: (_iiif_presentation_3.Selector | _iiif_presentation_3.Selector[]) | undefined;
-        styleClass?: string | undefined;
-        renderedVia?: (_iiif_presentation_3.Agent | _iiif_presentation_3.Agent[]) | undefined;
-        scope?: _iiif_presentation_3.LinkedResource;
-    } | {
-        id: any;
-        type: any;
+  resource: any;
+  warnings: string[];
+  errors: string[];
+  partOf: any;
+  references: ReferencedResource[];
+  embedded: CreatorResource[];
+  vault: Vault;
+  specificResource?: SpecificResource;
+  constructor(inputData: any, vault: Vault);
+  get(): any;
+  getSpecificResource(): {
+    created?: string | undefined;
+    generated?: string | undefined;
+    modified?: string | undefined;
+    creator?: _iiif_presentation_329.Creator | undefined;
+    generator?: _iiif_presentation_329.Creator | undefined;
+    audience?: (_iiif_presentation_329.Audience | _iiif_presentation_329.Audience[]) | undefined;
+    accessibility?: string | string[] | undefined;
+    motivation?: (_iiif_presentation_329.AnyMotivation | _iiif_presentation_329.AnyMotivation[]) | undefined;
+    rights?: string | string[] | undefined;
+    canonical?: string | undefined;
+    via?: string | string[] | undefined;
+    role?: string | undefined;
+    id?: string | undefined;
+    type: "SpecificResource";
+    state?: (_iiif_presentation_329.State | _iiif_presentation_329.State[]) | undefined;
+    purpose?: (_iiif_presentation_329.AnyMotivation | _iiif_presentation_329.AnyMotivation[]) | undefined;
+    source?: any;
+    selector?: (_iiif_presentation_329.Selector | _iiif_presentation_329.Selector[]) | undefined;
+    styleClass?: string | undefined;
+    renderedVia?: (_iiif_presentation_329.Agent | _iiif_presentation_329.Agent[]) | undefined;
+    scope?: _iiif_presentation_329.LinkedResource;
+  } | {
+    type: string;
+    source: {
+      id: any;
+      type: any;
     };
-    getAllReferencedResources(): ReferencedResource[];
-    getAllEmbeddedResources(): CreatorResource[];
-    getVaultResource(): any;
-    setPartOf(id: string): void;
+  };
+  ref(): {
+    created?: string | undefined;
+    generated?: string | undefined;
+    modified?: string | undefined;
+    creator?: _iiif_presentation_329.Creator | undefined;
+    generator?: _iiif_presentation_329.Creator | undefined;
+    audience?: (_iiif_presentation_329.Audience | _iiif_presentation_329.Audience[]) | undefined;
+    accessibility?: string | string[] | undefined;
+    motivation?: (_iiif_presentation_329.AnyMotivation | _iiif_presentation_329.AnyMotivation[]) | undefined;
+    rights?: string | string[] | undefined;
+    canonical?: string | undefined;
+    via?: string | string[] | undefined;
+    role?: string | undefined;
+    id?: string | undefined;
+    type: "SpecificResource";
+    state?: (_iiif_presentation_329.State | _iiif_presentation_329.State[]) | undefined;
+    purpose?: (_iiif_presentation_329.AnyMotivation | _iiif_presentation_329.AnyMotivation[]) | undefined;
+    source?: any;
+    selector?: (_iiif_presentation_329.Selector | _iiif_presentation_329.Selector[]) | undefined;
+    styleClass?: string | undefined;
+    renderedVia?: (_iiif_presentation_329.Agent | _iiif_presentation_329.Agent[]) | undefined;
+    scope?: _iiif_presentation_329.LinkedResource;
+  } | {
+    id: any;
+    type: any;
+  };
+  getAllReferencedResources(): ReferencedResource[];
+  getAllEmbeddedResources(): CreatorResource[];
+  getVaultResource(): any;
+  setPartOf(id: string): void;
 }
-
+//#endregion
+//#region src/CreatorInstance.d.ts
 declare class CreatorInstance implements CreatorFunctionContext {
-    vault: Vault;
-    previewVault: Vault;
-    configs: CreatorDefinition[];
-    options: CreatorOptions;
-    constructor(vault: Vault, options: CreatorOptions, createConfigs: CreatorDefinition[], previewVault: Vault);
-    getPreviewVault(): Vault;
-    getTarget(): SpecificResource | Reference | undefined;
-    getParent(): Reference | undefined;
-    getParentResource(): SpecificResource | undefined;
-    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<any>;
+  vault: Vault;
+  previewVault: Vault;
+  configs: CreatorDefinition[];
+  options: CreatorOptions;
+  target: CreatorOptions["target"];
+  selector: SupportedSelector | undefined | null;
+  serialisedSelector: {
+    type: string;
+    value: string;
+  } | null;
+  constructor(vault: Vault, options: CreatorOptions, createConfigs: CreatorDefinition[], previewVault: Vault);
+  getPreviewVault(): Vault;
+  setSelector(selector: SupportedSelector): void;
+  getSerialisedSelector(): {
+    type: "SvgSelector";
+    id: string;
+  } | {
+    type: string;
+    value: string;
+  } | null;
+  getTarget(): SpecificResource | Reference | undefined;
+  getParent(): Reference | undefined;
+  getParentResource(): SpecificResource | undefined;
+  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<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>;
+//#endregion
+//#region src/creator-register.d.ts
+declare function defineCreator<const Payload$1 = any, const ID$1 = Readonly<string>, const ResourceType$1 extends AllAvailableParentTypes = never, const AdditionalResourceTypes$1 extends Array<AllAvailableParentTypes> = [], const AllResourceTypes$1 = [ResourceType$1, ...AdditionalResourceTypes$1], const SupportsParentTypes$1 extends Array<AllAvailableParentTypes> = AllParentTypes, const SupportsParentFields$1 extends Array<AllProperties> = [], const CreateReturnType$1 = any>(options: SpecificCreatorDefinition<Payload$1, ID$1, ResourceType$1, AdditionalResourceTypes$1, AllResourceTypes$1, SupportsParentTypes$1, SupportsParentFields$1, CreateReturnType$1>): SpecificCreatorDefinition<Payload$1, ID$1, ResourceType$1, AdditionalResourceTypes$1, AllResourceTypes$1, SupportsParentTypes$1, SupportsParentFields$1, CreateReturnType$1>;
 declare namespace IIIFManifestEditor {
-    interface CreatorDefinitions {
-    }
+  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;
+  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];
-
+type HelperInArray<ToFind, Array$1 extends readonly any[]> = Array$1 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];
+//#endregion
+//#region src/types.d.ts
 interface CreatorContext<T = any> {
-    vault: Vault;
-    options: CreatorOptions;
-    validate: (payload: T) => Promise<boolean> | boolean;
-    runCreate: (payload: T) => void;
+  vault: Vault;
+  options: CreatorOptions;
+  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 {
-    vault: Vault;
-    options: CreatorOptions;
-    ref(idOrRef: string | Reference): ReferencedResource;
-    embed(data: any): 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;
+  vault: Vault;
+  options: CreatorOptions;
+  ref(idOrRef: string | Reference): ReferencedResource;
+  embed(data: any): 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;
-    atIndex?: number;
+  resource: Reference;
+  property: string;
+  atIndex?: number;
 }
 interface CreatorOptions {
-    targetType: string;
-    target?: Reference;
-    parent?: CreatorParent;
-    initialData?: any;
+  targetType: string;
+  target?: Reference;
+  parent?: CreatorParent;
+  initialData?: any;
+  rootId?: 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: 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>;
-    allowModal?: boolean;
-    hiddenModal?: boolean;
-    supports: {
-        initialData?: boolean;
-        parentTypes?: SupportsParentTypes;
-        parentFields?: SupportsParentFields;
-        parentFieldMap?: Record<string, string[]>;
-        custom?: (parent: CreatorParent, vault: Vault) => boolean;
-        disallowPainting?: boolean;
-    };
-    sideEffects?: Array<CreatorSideEffect>;
+type AllParentTypes = ["Collection", "Manifest", "Canvas", "Annotation", "AnnotationPage", "Range", "AnnotationCollection", "ContentResource", "Agent"];
+interface SpecificCreatorDefinition<Payload$1 = any, ID$1 = Readonly<string>, ResourceType$1 extends AllAvailableParentTypes = never, AdditionalResourceTypes$1 extends Array<AllAvailableParentTypes> = [], AllResourceTypes$1 = [ResourceType$1, ...AdditionalResourceTypes$1], SupportsParentTypes$1 extends Array<AllAvailableParentTypes> = AllParentTypes, SupportsParentFields$1 extends Array<AllProperties> = [], CreateReturnType$1 = any | Promise<any> | any[] | Promise<any[]>> {
+  readonly id: ID$1;
+  label: string;
+  summary?: string;
+  icon?: any;
+  dependencies?: string[];
+  tags?: string[];
+  create: (payload: Payload$1, ctx: CreatorInstance) => CreateReturnType$1;
+  validate?: (payload: Payload$1, vault: Vault) => void | Promise<void>;
+  render?: (ctx: CreatorContext<Payload$1>) => ReactNode;
+  renderCanvas?: (ctx: CreatorContext<Payload$1>) => ReactNode | null;
+  renderModal?: (ctx: CreatorContext<Payload$1>) => ReactNode;
+  resourceType: ResourceType$1;
+  additionalTypes?: AdditionalResourceTypes$1;
+  actionButton?: string;
+  resourceFields: string[];
+  embeddedResources?: string[];
+  staticFields?: Record<string, any>;
+  allowModal?: boolean;
+  hiddenModal?: boolean;
+  supports: {
+    initialData?: boolean;
+    parentTypes?: SupportsParentTypes$1;
+    parentFields?: SupportsParentFields$1;
+    parentFieldMap?: Record<string, string[]>;
+    custom?: (parent: CreatorParent, vault: Vault) => boolean;
+    disallowPainting?: boolean;
+    onlyPainting?: boolean;
+  };
+  sideEffects?: Array<CreatorSideEffect>;
 }
-type CreatorDefinition<Payload = any> = SpecificCreatorDefinition<Payload, any, any, any, any, any, any>;
+type CreatorDefinition<Payload$1 = any> = SpecificCreatorDefinition<Payload$1, any, any, any, any, any, any>;
 interface CreatorSideEffect {
-    run?: (result: any, ctx: {
-        options: CreatorOptions;
-        vault: Vault;
-    }) => void | Promise<void>;
-    temporal?: boolean;
-    spatial?: boolean;
-    replaceSiblings?: boolean;
-    canvasInteraction?: boolean;
+  run?: (result: any, ctx: {
+    options: CreatorOptions;
+    vault: Vault;
+  }) => void | Promise<void>;
+  temporal?: boolean;
+  spatial?: boolean;
+  replaceSiblings?: boolean;
+  canvasInteraction?: boolean;
 }
 interface CreatableResource {
-    type: string;
-    parent?: Reference;
-    property?: string;
-    index?: number;
-    onlyReference?: boolean;
-    target?: Reference;
-    initialData?: any;
-    isPainting?: boolean;
-    filter?: string;
-    initialCreator?: string;
+  type: string;
+  parent?: Reference;
+  property?: string;
+  index?: number;
+  onlyReference?: boolean;
+  target?: Reference;
+  initialData?: any;
+  isPainting?: boolean;
+  filter?: string;
+  initialCreator?: string;
 }
-
+//#endregion
+//#region src/Creator.d.ts
 declare class Creator {
-    configs: CreatorDefinition[];
-    vault: Vault;
-    previewVault: Vault;
-    constructor(vault: Vault, configs: CreatorDefinition[], previewVault?: Vault);
-    matchBasedOnResource(resource: CreatableResource): CreatorDefinition[];
-    create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<Reference | Reference[]>;
+  configs: CreatorDefinition[];
+  vault: Vault;
+  previewVault: Vault;
+  constructor(vault: Vault, configs: CreatorDefinition[], previewVault?: Vault);
+  matchBasedOnResource(resource: CreatableResource): CreatorDefinition[];
+  create(definition: string, payload: any, options?: Partial<CreatorOptions>): Promise<Reference | Reference[]>;
 }
-
+//#endregion
+//#region src/utils.d.ts
 declare function resolveType(type: string): keyof Entities;
 declare function getEmptyType(type: string): any;
 declare function randomId(): string;
 declare function matchBasedOnResource(resource: CreatableResource, list: CreatorDefinition[], options: {
-    vault: Vault;
+  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 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 };
+declare function creatorHelper<const ResourceType$1 extends AllAvailableParentTypes, const Parent extends {
+  id: string;
+  type: ResourceType$1;
+}, const ResourceField extends GetSupportedResourceFields<ResourceType$1>, const CID extends CreatorDefinitionFilterByParent<ResourceType$1, ResourceField>["id"], Payload$1 = GetCreatorPayload<IIIFManifestEditor.CreatorDefinitions[CID]>, Return = ResolvedCreatorReturn<IIIFManifestEditor.CreatorDefinitions[CID]>>(ctx: CreatorFunctionContext, parent: Parent | ResourceType$1, property: ResourceField, definition: CID): (payload: Payload$1, options?: Partial<CreatorOptions>) => Promise<Return>;
+//#endregion
+export { AllAvailableParentTypes, AllParentTypes, AllProperties, CreatableResource, Creator, CreatorContext, CreatorDefinition, CreatorDefinitionFilterByParent, CreatorFunctionContext, CreatorOptions, CreatorResource, CreatorSideEffect, ExtractCreatorGenerics, GetCreatorPayload, GetSupportedResourceFields, IIIFManifestEditor, ResolvedCreatorReturn, SpecificCreatorDefinition, creatorHelper, defineCreator, getEmptyType, matchBasedOnResource, randomId, resolveType };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/ReferencedResource.ts","../src/CreatorResource.ts","../src/CreatorInstance.ts","../src/creator-register.ts","../src/types.ts","../src/Creator.ts","../src/utils.ts"],"sourcesContent":[],"mappings":";;;;;;;;cAIa,kBAAA;SACJ;YACG,YAAY;aACX;YACD;yBACa,YAAY,yBAAyB;EALjD,GAAA,CAAA,CAAA,EAAA;IACJ,IAAA,EAAA,MAAA;IACG,EAAA,EAAA,MAAA;EAAY,CAAA;EACX,gBAAA,CAAA,CAAA,EAAA;IACD,OAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IACa,SAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IAAY,QAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IAAyB,OAAA,CAAA,EAAK,sBAAA,CAAA,OAAA,GAAL,SAAA;IAAK,SAAA,CAAA,mCAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ICFtD,MAAA,CAAA,EAAA,MAAe,GAAA,MAAA,EAAA,GAAA,SAAA;IAKd,SAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IACF,GAAA,CAAA,EAAA,MAAA,GAAA,MAAA,EAAA,GAAA,SAAA;IACH,IAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IACY,EAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IAEgB,IAAA,EAAA,kBAAA;IAAK,KAAA,CAAA,EAAA,8DAAA,CAAA,GAAA,SAAA;;;;;;;;;;;cAV7B,eAAA;;;;;EDHA,UAAA,ECQC,kBDRiB,EAAA;EACtB,QAAA,ECQG,eDRH,EAAA;EACG,KAAA,ECQH,KDRG;EAAY,gBAAA,CAAA,ECSH,gBDTG;EACX,WAAA,CAAA,SAAA,EAAA,GAAA,EAAA,KAAA,ECUwB,KDVxB;EACD,GAAA,CAAA,CAAA,EAAA,GAAA;EACa,mBAAA,CAAA,CAAA,EAAA;IAAY,OAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IAAyB,SAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IAAK,QAAA,CAAA,EAAA,MAAA,GAAA,SAAA;cCQzB,sBAAA,CAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAV7B,UAAA,CAAA,EAAA,8EAAe,CAAA,GAAA,SAAA;IAKd,MAAA,CAAA,EAAA,MAAA,GAAA,MAAA,EAAA,GAAA,SAAA;IACF,SAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IACH,GAAA,CAAA,EAAA,MAAA,GAAA,MAAA,EAAA,GAAA,SAAA;IACY,IAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IAEgB,EAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IAAK,IAAA,EAAA,kBAAA;;;;;;;;;;;;+BA8If;6BAIE;;;;;;cCrIhB,eAAA,YAA2B;SAC/B;EF3BI,YAAA,EE4BG,KF5BH;EACJ,OAAA,EE4BE,iBF5BF,EAAA;EACG,OAAA,EE4BD,cF5BC;EAAY,MAAA,EE8Bd,cF9Bc,CAAA,QAAA,CAAA;EACX,QAAA,EE8BD,iBF9BC,GAAA,SAAA,GAAA,IAAA;EACD,kBAAA,EAAA;IACa,IAAA,EAAA,MAAA;IAAY,KAAA,EAAA,MAAA;EAAyB,CAAA,GAAA,IAAA;EAAK,WAAA,CAAA,KAAA,EEgCxD,KFhCwD,EAAA,OAAA,EEiCtD,cFjCsD,EAAA,aAAA,EEkChD,iBFlCgD,EAAA,EAAA,YAAA,EEmCjD,KFnCiD;qBEkDlD;wBAIO;;;;;;;;eAqBT,mBAAmB;eAenB;uBAGQ;oCAUa,YAAY;wBAWxB,YAAS;oBAuBhB;qDAOH,QAAQ,kBAAe;;;;iBC/GrB,kDAEH,+CACgB,yEACW,MAAM,2DAClB,mBAAiB,gEACT,MAAM,2BAA2B,qDAChC,MAAM,8DAGhC,0BACP,WACA,MACA,gBACA,2BACA,oBACA,uBACA,wBACA,sBACD,0BAAA,WAAA,MAAA,gBAAA,2BAAA,oBAAA,uBAAA,wBAAA;kBAKsB,kBAAA;;;KAKb,iCAAiC,qBAAqB,UAAU;WAW7D;EH9EF,EAAA,EG+EH,EH/EG;EACJ,YAAA,EG+EW,YH/EX;EACG,uBAAA,EG+EmB,uBH/EnB;EAAY,gBAAA,EGgFA,gBHhFA;EACX,mBAAA,EGgFc,mBHhFd;EACD,oBAAA,EGgFgB,oBHhFhB;EACa,gBAAA,EGgFD,gBHhFC;CAAY,GAAA,KAAA;KGoFhC,0BHpFyD,CAAA,CAAA,EAAA,aGoFd,uBHpFc,CAAA,GGoFa,CHpFb,SGoFuB,iBHpFvB,GGqF1D,sBHrF0D,CGqFnC,CHrFmC,CAAA,CAAA,qBAAA,CAAA,SAAA,KAAA,GAAA,KAAA,GGuFxD,aHvFwD,CGuF1C,IHvF0C,EGuFpC,sBHvFoC,CGuFb,CHvFa,CAAA,CAAA,qBAAA,CAAA,CAAA,GAAA,KAAA;KG0FzD,2BH1F8D,CAAA,CAAA,EAAA,cG0FjB,aH1FiB,CAAA,GG0FA,CH1FA,SG0FU,iBH1FV,GG2F/D,sBH3F+D,CG2FxC,CH3FwC,CAAA,CAAA,sBAAA,CAAA,SAAA,KAAA,GAAA,KAAA,GG6F7D,aH7F6D,CG6F/C,KH7F+C,EG6FxC,sBH7FwC,CG6FjB,CH7FiB,CAAA,CAAA,sBAAA,CAAA,CAAA,GAAA,KAAA;KGgG9D,sCAEU,uCACC,iBACZ,UAAU,oBACV,2BAA2B,GAAG,qBAC5B,4BAA4B,GAAG;KAMhC,wDAAsD,uDACvD,aAAa,gBAEX,cAAc,QAAQ;KAGhB,6CACG,uCACC,gBAAgB,0BACnB,kBAAA,CAAmB,qBAAqB,kBAAA,CAAmB,oCAE1D,KAAK,sBAAsB,GAAG,IAAI,MAAM,sBAAsB,GAAG,mBACvE;;;AH7HK,UIqBI,cJrBc,CAAA,IAAA,GAAA,CAAA,CAAA;EACtB,KAAA,EIqBA,KJrBA;EACG,OAAA,EIqBD,cJrBC;EAAY,QAAA,EAAA,CAAA,OAAA,EIsBF,CJtBE,EAAA,GIsBI,OJtBJ,CAAA,OAAA,CAAA,GAAA,OAAA;EACX,SAAA,EAAA,CAAA,OAAA,EIsBU,CJtBV,EAAA,GAAA,IAAA;;AAEY,KIuBb,qBJvBa,CAAA,UIuBmB,iBJvBnB,CAAA,GIwBvB,OJxBuB,CIwBf,sBJxBe,CIwBQ,CJxBR,CAAA,CAAA,kBAAA,CAAA,CAAA,SAAA,GAAA,EAAA,GIyBnB,eJzBmB,EAAA,GI0BnB,eJ1BmB;AAAY,UI4BpB,sBAAA,CJ5BoB;EAAyB,KAAA,EI6BrD,KJ7BqD;EAAK,OAAA,EI8BxD,cJ9BwD;wBI+B3C,YAAY;oBAChB;qDAKN,QAAQ,kBACjB,QAAQ,kBAAkB;4BACH,qCACZ,2BACH,kBAAkB,uBACjB,QAAQ,kBACjB,QAAQ,sBAAsB;oCAEC,YAAY;eACjC;eACA,mBAAmB;uBACX;qBACF;;KAGT,4BAA4B,qBACtC,UAAU,mCAAmC;UAErC,aAAA;YACE;;;;UAIK,cAAA;;WAEN;WACA;;;;KAKC,uBAAA,gBAAuC,SAAA,CAAU;KAIjD,4CACO,wCACF,SAAA,CAAU,WAAW;KAE1B,aAAA,eACI,iCACA,yCACA,mCACA,qCACA,0BACA;KAEJ,cAAA,iFHtFC,sBAAe,EAKd,iBAAA,EACF,OAAA,CACH;AACY,UG0FJ,yBH1FI,CAAA,YAAA,GAAA,EAAA,OG6Fd,QH7Fc,CAAA,MAAA,CAAA,EAAA,uBG8FE,uBH9FF,GAAA,KAAA,EAAA,kCG+Fa,KH/Fb,CG+FmB,uBH/FnB,CAAA,GAAA,EAAA,EAAA,qBAAA,CGgGC,cHhGD,EAAA,GGgGkB,yBHhGlB,CAAA,EAAA,8BGiGS,KHjGT,CGiGe,uBHjGf,CAAA,GGiG0C,cHjG1C,EAAA,+BGkGU,KHlGV,CGkGgB,aHlGhB,CAAA,GAAA,EAAA,EAAA,qBAAA,GAAA,GGmGM,OHnGN,CAAA,GAAA,CAAA,GAAA,GAAA,EAAA,GGmG6B,OHnG7B,CAAA,GAAA,EAAA,CAAA,CAAA,CAAA;EAEgB,SAAA,EAAA,EGoGtB,IHpGsB;EAAK,KAAA,EAAA,MAAA;;;;;oBG2GtB,gBAAc,oBAAoB;uBAC/B,kBAAgB,iBAAiB;iBAEvC,eAAe,eAAa;uBACtB,eAAe,eAAa;sBAC7B,eAAe,eAAa;gBAGlC;oBACI;;;;iBAKH;;;;;kBAOC;mBACC;qBACE;sBACC,sBAAsB;;;;gBAM5B,MAAM;;KAIV,qCAAmC,0BAC7C;AHAyB,UGSV,iBAAA,CHTU;EAIE,GAAA,CAAA,EAAA,CAAA,MAAA,EAAA,GAAA,EAAA,GAAA,EAAA;IAAe,OAAA,EGQxB,cHRwB;WGQD;eAC7B;;EF9ID,OAAA,CAAA,EAAA,OAAA;EACJ,eAAA,CAAA,EAAA,OAAA;EACO,iBAAA,CAAA,EAAA,OAAA;;AAEL,UEkJM,iBAAA,CFlJN;EAED,IAAA,EAAA,MAAA;EACE,MAAA,CAAA,EEiJD,SFjJC;EAID,QAAA,CAAA,EAAA,MAAA;EACE,KAAA,CAAA,EAAA,MAAA;EACM,aAAA,CAAA,EAAA,OAAA;EACD,MAAA,CAAA,EE8IP,SF9IO;EAeD,WAAA,CAAA,EAAA,GAAA;EAIO,UAAA,CAAA,EAAA,OAAA;EAqBT,MAAA,CAAA,EAAA,MAAA;EAAmB,cAAA,CAAA,EAAA,MAAA;;;;cG7ErB,OAAA;WACF;SACF;gBACO;qBAEK,gBAAgB,oCAAoC;ELR5D,oBAAA,CAAkB,QAAA,EKcE,iBLdF,CAAA,EKcmB,iBLdnB,EAAA;EACtB,MAAA,CAAA,UAAA,EAAA,MAAA,EAAA,OAAA,EAAA,GAAA,EAAA,OAAA,CAAA,EKiBkD,OLjBlD,CKiB0D,cLjB1D,CAAA,CAAA,EKiB4E,OLjB5E,CKiBoF,SLjBpF,GKiBgG,SLjBhG,EAAA,CAAA;;;;iBMsBO,WAAA,sBAAiC;iBAiCjC,YAAA;iBAKA,QAAA,CAAA;iBAIA,oBAAA,WACJ,yBACJ;SACY;ANpEpB,CAAA,CAAA,EMqEG,iBNrEU,EAAA;AACJ,iBM4IO,aN5IP,CAAA,6BM6IoB,uBN7IpB,EAAA,qBAAA;EACG,EAAA,EAAA,MAAA;EAAY,IAAA,EM6ImB,cN7InB;CACX,EAAA,4BM6IiB,0BN7IjB,CM6I4C,cN7I5C,CAAA,EAAA,kBM8IO,+BN9IP,CM+IT,cN/IS,EMgJT,aNhJS,CAAA,CAAA,IAAA,CAAA,EAAA,YMkJD,iBNlJC,CMkJiB,kBAAA,CAAmB,kBNlJpC,CMkJuD,GNlJvD,CAAA,CAAA,EAAA,SMmJF,qBNnJE,CMmJoB,kBAAA,CAAmB,kBNnJvC,CMmJ0D,GNnJ1D,CAAA,CAAA,CAAA,CAAA,GAAA,EMqJN,sBNrJM,EAAA,MAAA,EMsJH,MNtJG,GMsJM,cNtJN,EAAA,QAAA,EMuJD,aNvJC,EAAA,UAAA,EMwJC,GNxJD,CAAA,EAAA,CAAA,OAAA,EMyJA,SNzJA,EAAA,OAAA,CAAA,EMyJmB,ONzJnB,CMyJ2B,cNzJ3B,CAAA,EAAA,GMyJ+C,ONzJ/C,CMyJuD,MNzJvD,CAAA"}