@myrmidon/cadmus-refs-asserted-ids 2.0.0 → 2.1.0

package/lib/asserted-composite-ids/asserted-composite-ids.component.d.ts

@@ -0,0 +1,67 @@
+import { EventEmitter } from '@angular/core';
+import { FormBuilder, FormControl, FormGroup } from '@angular/forms';
+import { IndexLookupDefinitions, ThesaurusEntry } from '@myrmidon/cadmus-core';
+import { DialogService } from '@myrmidon/ng-mat-tools';
+import { AssertedCompositeId } from '../asserted-composite-id/asserted-composite-id.component';
+import * as i0 from "@angular/core";
+/**
+ * Asserted IDs editor.
+ */
+export declare class AssertedCompositeIdsComponent {
+    private _dialogService;
+    private _ids;
+    private _editedIndex;
+    edited?: AssertedCompositeId;
+    /**
+     * The asserted IDs.
+     */
+    get ids(): AssertedCompositeId[];
+    set ids(value: AssertedCompositeId[]);
+    idScopeEntries?: ThesaurusEntry[];
+    idTagEntries?: ThesaurusEntry[];
+    assTagEntries?: ThesaurusEntry[];
+    refTypeEntries: ThesaurusEntry[] | undefined;
+    refTagEntries: ThesaurusEntry[] | undefined;
+    /**
+     * True when the internal UI preselected mode should be by type rather than
+     * by item. User can change mode unless modeSwitching is false.
+     */
+    pinByTypeMode?: boolean;
+    /**
+     * True when the user can switch between by-type and by-item mode in
+     * the internal UI.
+     */
+    canSwitchMode?: boolean;
+    /**
+     * True when the user can edit the target's gid/label for internal targets.
+     */
+    canEditTarget?: boolean;
+    /**
+     * The lookup definitions to be used for the by-type lookup in the internal UI.
+     * If not specified, the lookup definitions will be got via injection
+     * when available; if the injected definitions are empty, the
+     * lookup definitions will be built from the model-types thesaurus;
+     * if this is not available either, the by-type lookup will be
+     * disabled.
+     */
+    lookupDefinitions?: IndexLookupDefinitions;
+    /**
+     * Emitted whenever any ID changes.
+     */
+    idsChange: EventEmitter<AssertedCompositeId[]>;
+    entries: FormControl<AssertedCompositeId[]>;
+    form: FormGroup;
+    constructor(formBuilder: FormBuilder, _dialogService: DialogService);
+    private updateForm;
+    private emitIdsChange;
+    addId(): void;
+    editId(id: AssertedCompositeId, index: number): void;
+    closeId(): void;
+    saveId(entry: AssertedCompositeId): void;
+    deleteId(index: number): void;
+    moveIdUp(index: number): void;
+    moveIdDown(index: number): void;
+    onIdChange(id: AssertedCompositeId): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AssertedCompositeIdsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AssertedCompositeIdsComponent, "cadmus-refs-asserted-composite-ids", never, { "ids": { "alias": "ids"; "required": false; }; "idScopeEntries": { "alias": "idScopeEntries"; "required": false; }; "idTagEntries": { "alias": "idTagEntries"; "required": false; }; "assTagEntries": { "alias": "assTagEntries"; "required": false; }; "refTypeEntries": { "alias": "refTypeEntries"; "required": false; }; "refTagEntries": { "alias": "refTagEntries"; "required": false; }; "pinByTypeMode": { "alias": "pinByTypeMode"; "required": false; }; "canSwitchMode": { "alias": "canSwitchMode"; "required": false; }; "canEditTarget": { "alias": "canEditTarget"; "required": false; }; "lookupDefinitions": { "alias": "lookupDefinitions"; "required": false; }; }, { "idsChange": "idsChange"; }, never, never, false, never>;
+}

package/lib/cadmus-refs-asserted-ids.module.d.ts

@@ -1,22 +1,28 @@
 import * as i0 from "@angular/core";
 import * as i1 from "./asserted-id/asserted-id.component";
 import * as i2 from "./asserted-ids/asserted-ids.component";
-import * as i3 from "./scoped-pin-lookup/scoped-pin-lookup.component";
-import * as i4 from "@angular/common";
-import * as i5 from "@angular/forms";
-import * as i6 from "@angular/material/button";
-import * as i7 from "@angular/material/expansion";
-import * as i8 from "@angular/material/form-field";
-import * as i9 from "@angular/material/icon";
-import * as i10 from "@angular/material/input";
-import * as i11 from "@angular/material/select";
-import * as i12 from "@myrmidon/cadmus-core";
-import * as i13 from "@myrmidon/cadmus-refs-doc-references";
-import * as i14 from "@myrmidon/cadmus-refs-assertion";
-import * as i15 from "@myrmidon/cadmus-refs-lookup";
-import * as i16 from "@myrmidon/cadmus-api";
+import * as i3 from "./asserted-composite-id/asserted-composite-id.component";
+import * as i4 from "./asserted-composite-ids/asserted-composite-ids.component";
+import * as i5 from "./pin-target-lookup/pin-target-lookup.component";
+import * as i6 from "./scoped-pin-lookup/scoped-pin-lookup.component";
+import * as i7 from "@angular/common";
+import * as i8 from "@angular/forms";
+import * as i9 from "@angular/cdk/clipboard";
+import * as i10 from "@angular/material/button";
+import * as i11 from "@angular/material/checkbox";
+import * as i12 from "@angular/material/expansion";
+import * as i13 from "@angular/material/form-field";
+import * as i14 from "@angular/material/icon";
+import * as i15 from "@angular/material/input";
+import * as i16 from "@angular/material/select";
+import * as i17 from "@myrmidon/ng-tools";
+import * as i18 from "@myrmidon/cadmus-core";
+import * as i19 from "@myrmidon/cadmus-refs-doc-references";
+import * as i20 from "@myrmidon/cadmus-refs-assertion";
+import * as i21 from "@myrmidon/cadmus-refs-lookup";
+import * as i22 from "@myrmidon/cadmus-api";
 export declare class CadmusRefsAssertedIdsModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<CadmusRefsAssertedIdsModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<CadmusRefsAssertedIdsModule, [typeof i1.AssertedIdComponent, typeof i2.AssertedIdsComponent, typeof i3.ScopedPinLookupComponent], [typeof i4.CommonModule, typeof i5.FormsModule, typeof i5.ReactiveFormsModule, typeof i6.MatButtonModule, typeof i7.MatExpansionModule, typeof i8.MatFormFieldModule, typeof i9.MatIconModule, typeof i10.MatInputModule, typeof i11.MatSelectModule, typeof i12.CadmusCoreModule, typeof i13.CadmusRefsDocReferencesModule, typeof i14.CadmusRefsAssertionModule, typeof i15.CadmusRefsLookupModule, typeof i16.CadmusApiModule], [typeof i1.AssertedIdComponent, typeof i2.AssertedIdsComponent, typeof i3.ScopedPinLookupComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<CadmusRefsAssertedIdsModule, [typeof i1.AssertedIdComponent, typeof i2.AssertedIdsComponent, typeof i3.AssertedCompositeIdComponent, typeof i4.AssertedCompositeIdsComponent, typeof i5.PinTargetLookupComponent, typeof i6.ScopedPinLookupComponent], [typeof i7.CommonModule, typeof i8.FormsModule, typeof i8.ReactiveFormsModule, typeof i9.ClipboardModule, typeof i10.MatButtonModule, typeof i11.MatCheckboxModule, typeof i12.MatExpansionModule, typeof i13.MatFormFieldModule, typeof i14.MatIconModule, typeof i15.MatInputModule, typeof i16.MatSelectModule, typeof i17.NgToolsModule, typeof i18.CadmusCoreModule, typeof i19.CadmusRefsDocReferencesModule, typeof i20.CadmusRefsAssertionModule, typeof i21.CadmusRefsLookupModule, typeof i22.CadmusApiModule], [typeof i1.AssertedIdComponent, typeof i2.AssertedIdsComponent, typeof i3.AssertedCompositeIdComponent, typeof i4.AssertedCompositeIdsComponent, typeof i5.PinTargetLookupComponent, typeof i6.ScopedPinLookupComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<CadmusRefsAssertedIdsModule>;
 }

package/lib/pin-target-lookup/pin-target-lookup.component.d.ts

@@ -0,0 +1,139 @@
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import { FormBuilder, FormControl, FormGroup } from '@angular/forms';
+import { MatSnackBar } from '@angular/material/snack-bar';
+import { ItemService, ThesaurusService } from '@myrmidon/cadmus-api';
+import { DataPinInfo, IndexLookupDefinition, IndexLookupDefinitions, Item, Part, ThesaurusEntry } from '@myrmidon/cadmus-core';
+import { PinRefLookupFilter, PinRefLookupService } from '../services/pin-ref-lookup.service';
+import { ItemRefLookupService } from '../services/item-ref-lookup.service';
+import * as i0 from "@angular/core";
+interface MetadataPart extends Part {
+    metadata: {
+        type?: string;
+        name: string;
+        value: string;
+    }[];
+}
+/**
+ * Pin lookup data used internally by the component.
+ */
+export interface PinLookupData {
+    pin: DataPinInfo;
+    item?: Item;
+    metaPart?: MetadataPart;
+}
+/**
+ * A pin-based target. This includes pin's name and value, and
+ * the item's ID and optional part IDs. The label is a user friendly
+ * string representation of the target, while the gid is a globally
+ * unique identifier for the target.
+ */
+export interface PinTarget {
+    gid: string;
+    label: string;
+    itemId?: string;
+    partId?: string;
+    partTypeId?: string;
+    roleId?: string;
+    name?: string;
+    value?: string;
+}
+export declare class PinTargetLookupComponent implements OnInit, OnDestroy {
+    private _presetLookupDefs;
+    itemLookupService: ItemRefLookupService;
+    pinLookupService: PinRefLookupService;
+    private _itemService;
+    private _thesService;
+    private _snackbar;
+    private _subs;
+    private _target;
+    private _noFormUpdate?;
+    private _startWithByTypeMode?;
+    /**
+     * True when the by-type pin lookup mode is active.
+     * User can change mode unless modeSwitching is false.
+     */
+    get pinByTypeMode(): boolean | undefined;
+    set pinByTypeMode(value: boolean | undefined);
+    /**
+     * True when the user can switch between by-type and by-item mode.
+     */
+    canSwitchMode?: boolean;
+    /**
+     * True when the user can edit the target's gid/label for internal
+     * targets.
+     */
+    canEditTarget?: boolean;
+    /**
+     * The lookup definitions to be used for the by-type lookup. If
+     * not specified, the lookup definitions will be got via injection
+     * when available; if the injected definitions are empty, the
+     * lookup definitions will be built from the model-types thesaurus;
+     * if this is not available either, the by-type lookup will be
+     * disabled.
+     */
+    lookupDefinitions?: IndexLookupDefinitions;
+    /**
+     * The target to be edited.
+     */
+    get target(): PinTarget | undefined | null;
+    set target(value: PinTarget | undefined | null);
+    /**
+     * Emitted when user closes the editor.
+     */
+    editorClose: EventEmitter<any>;
+    /**
+     * Emitted whenever the target changes.
+     * The event's value is the new target.
+     */
+    targetChange: EventEmitter<PinTarget>;
+    modelEntries: ThesaurusEntry[];
+    partTypeKeys: string[];
+    itemParts: Part[];
+    item: FormControl<Item | null>;
+    itemPart: FormControl<Part | null>;
+    partTypeKey: FormControl<string | null>;
+    gid: FormControl<string | null>;
+    label: FormControl<string | null>;
+    byTypeMode: FormControl<boolean>;
+    external: FormControl<boolean>;
+    form: FormGroup;
+    filter: PinRefLookupFilter;
+    pinFilterOptions?: IndexLookupDefinition;
+    lookupData?: PinLookupData;
+    constructor(_presetLookupDefs: IndexLookupDefinitions, itemLookupService: ItemRefLookupService, pinLookupService: PinRefLookupService, _itemService: ItemService, _thesService: ThesaurusService, _snackbar: MatSnackBar, formBuilder: FormBuilder);
+    private forceByItem;
+    private setupKeys;
+    private canBuildGid;
+    private canBuildLabel;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    private buildGid;
+    private buildLabel;
+    private getTarget;
+    private updateTarget;
+    private updateForm;
+    /**
+     * Called when the item lookup changes (item is looked up
+     * by its title).
+     *
+     * @param item The item got from lookup.
+     */
+    onItemLookupChange(item: Item): void;
+    private loadItemInfo;
+    /**
+     * Called when the pin lookup change. A pin is looked up by its
+     * name and value (=the filter's text), and optionally by:
+     * - its index lookup definition (selected by partTypeKey).
+     * - its item (defined by item, in filter).
+     * - its part (defined by itemPart, in filter).
+     *
+     * @param info The pin info from pin lookup.
+     */
+    onPinLookupChange(info: DataPinInfo): void;
+    onCopied(): void;
+    close(): void;
+    save(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PinTargetLookupComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<PinTargetLookupComponent, "cadmus-pin-target-lookup", never, { "pinByTypeMode": { "alias": "pinByTypeMode"; "required": false; }; "canSwitchMode": { "alias": "canSwitchMode"; "required": false; }; "canEditTarget": { "alias": "canEditTarget"; "required": false; }; "lookupDefinitions": { "alias": "lookupDefinitions"; "required": false; }; "target": { "alias": "target"; "required": false; }; }, { "editorClose": "editorClose"; "targetChange": "targetChange"; }, never, never, false, never>;
+}
+export {};

package/lib/services/item-ref-lookup.service.d.ts

@@ -0,0 +1,13 @@
+import { Observable } from 'rxjs';
+import { ItemService } from '@myrmidon/cadmus-api';
+import { Item } from '@myrmidon/cadmus-core';
+import { RefLookupFilter, RefLookupService } from '@myrmidon/cadmus-refs-lookup';
+import * as i0 from "@angular/core";
+export declare class ItemRefLookupService implements RefLookupService {
+    private _itemService;
+    constructor(_itemService: ItemService);
+    lookup(filter: RefLookupFilter, options?: any): Observable<Item[]>;
+    getName(item: Item): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ItemRefLookupService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ItemRefLookupService>;
+}

package/lib/services/pin-ref-lookup.service.d.ts

@@ -2,6 +2,15 @@ import { Observable } from 'rxjs';
 import { ItemService } from '@myrmidon/cadmus-api';
 import { RefLookupFilter, RefLookupService } from '@myrmidon/cadmus-refs-lookup';
 import * as i0 from "@angular/core";
+/**
+ * Pin-based lookup filter. This is a RefLookupFilter with the addition
+ * of the item ID and part ID, which are used to filter the results
+ * by the ItemPinLookupComponent.
+ */
+export interface PinRefLookupFilter extends RefLookupFilter {
+    itemId?: string;
+    partId?: string;
+}
 /**
  * Cadmus pin-based lookup data service. The text being searched here is just
  * the pin's value, according to the options specified. These options correspond
@@ -12,7 +21,7 @@ export declare class PinRefLookupService implements RefLookupService {
     constructor(_itemService: ItemService);
     getName(item: any | undefined): string;
     private buildQuery;
-    lookup(filter: RefLookupFilter, options?: any): Observable<any[]>;
+    lookup(filter: PinRefLookupFilter, options?: any): Observable<any[]>;
     static ɵfac: i0.ɵɵFactoryDeclaration<PinRefLookupService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<PinRefLookupService>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myrmidon/cadmus-refs-asserted-ids",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Cadmus - asserted IDs components.",
   "keywords": [
     "Cadmus",

package/public-api.d.ts

@@ -1,5 +1,9 @@
 export * from './lib/asserted-id/asserted-id.component';
 export * from './lib/asserted-ids/asserted-ids.component';
 export * from './lib/scoped-pin-lookup/scoped-pin-lookup.component';
+export * from './lib/asserted-composite-id/asserted-composite-id.component';
+export * from './lib/asserted-composite-ids/asserted-composite-ids.component';
+export * from './lib/pin-target-lookup/pin-target-lookup.component';
 export * from './lib/services/pin-ref-lookup.service';
+export * from './lib/services/item-ref-lookup.service';
 export * from './lib/cadmus-refs-asserted-ids.module';