@didcid/gatekeeper 0.1.3 → 0.3.0

package/dist/esm/search-index.js

@@ -0,0 +1,118 @@
+export default class SearchIndex {
+    docs = new Map();
+    static ARRAY_WILDCARD_END = /\[\*]$/;
+    static ARRAY_WILDCARD_MID = /\[\*]\./;
+    store(did, doc) {
+        // Only index didDocumentData to focus on actual content
+        const data = doc.didDocumentData;
+        if (data && typeof data === 'object') {
+            this.docs.set(did, JSON.parse(JSON.stringify(data)));
+        }
+        else {
+            this.docs.set(did, {});
+        }
+    }
+    delete(did) {
+        this.docs.delete(did);
+    }
+    clear() {
+        this.docs.clear();
+    }
+    get size() {
+        return this.docs.size;
+    }
+    searchDocs(q) {
+        const out = [];
+        for (const [did, doc] of this.docs.entries()) {
+            if (JSON.stringify(doc).includes(q))
+                out.push(did);
+        }
+        return out;
+    }
+    queryDocs(where) {
+        const entry = Object.entries(where)[0];
+        if (!entry) {
+            return [];
+        }
+        const [rawPath, cond] = entry;
+        if (typeof cond !== 'object' || cond === null || !Array.isArray(cond.$in)) {
+            throw new Error('Only {$in:[...]} supported');
+        }
+        const list = cond.$in;
+        const isKeyWildcard = rawPath.endsWith('.*');
+        const isValueWildcard = rawPath.includes('.*.');
+        const isArrayTail = SearchIndex.ARRAY_WILDCARD_END.test(rawPath);
+        const isArrayMid = SearchIndex.ARRAY_WILDCARD_MID.test(rawPath);
+        const result = [];
+        for (const [did, doc] of this.docs.entries()) {
+            let match = false;
+            if (isArrayTail) {
+                const basePath = rawPath.replace(SearchIndex.ARRAY_WILDCARD_END, '');
+                const arr = this.getPath(doc, basePath);
+                if (Array.isArray(arr)) {
+                    match = arr.some(v => list.includes(v));
+                }
+            }
+            else if (isArrayMid) {
+                const [prefix, suffix] = rawPath.split('[*].');
+                const arr = this.getPath(doc, prefix);
+                if (Array.isArray(arr)) {
+                    match = arr.some(el => list.includes(this.getPath(el, suffix)));
+                }
+            }
+            else if (isKeyWildcard) {
+                const basePath = rawPath.slice(0, -2);
+                const obj = this.getPath(doc, basePath);
+                if (obj && typeof obj === 'object' && !Array.isArray(obj)) {
+                    const keys = Object.keys(obj);
+                    match = keys.some(k => list.includes(k));
+                }
+            }
+            else if (isValueWildcard) {
+                const [prefix, suffix] = rawPath.split('.*.');
+                const obj = this.getPath(doc, prefix);
+                if (obj && typeof obj === 'object' && !Array.isArray(obj)) {
+                    const values = Object.values(obj);
+                    match = values.some(v => list.includes(this.getPath(v, suffix)));
+                }
+            }
+            else {
+                const val = this.getPath(doc, rawPath);
+                match = list.includes(val);
+            }
+            if (match) {
+                result.push(did);
+            }
+        }
+        return result;
+    }
+    getPath(root, path) {
+        if (!path || root == null) {
+            return undefined;
+        }
+        const clean = path.startsWith('$.') ? path.slice(2) : path.startsWith('$') ? path.slice(1) : path;
+        if (!clean) {
+            return root;
+        }
+        const parts = clean.split('.');
+        let cur = root;
+        for (const rawPart of parts) {
+            if (cur == null) {
+                return undefined;
+            }
+            const idx = Number.isInteger(+rawPart) ? +rawPart : null;
+            if (idx !== null && Array.isArray(cur)) {
+                cur = cur[idx];
+                continue;
+            }
+            if (typeof cur === 'object') {
+                cur = cur[rawPart];
+            }
+            else {
+                return undefined;
+            }
+        }
+        return cur;
+    }
+}
+//# sourceMappingURL=search-index.js.map

package/dist/esm/search-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-index.js","sourceRoot":"","sources":["../../src/search-index.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,OAAO,OAAO,WAAW;IACpB,IAAI,GAAG,IAAI,GAAG,EAAsB,CAAC;IACrC,MAAM,CAAU,kBAAkB,GAAG,QAAQ,CAAC;IAC9C,MAAM,CAAU,kBAAkB,GAAG,SAAS,CAAC;IAEvD,KAAK,CAAC,GAAW,EAAE,GAAW;QAC1B,wDAAwD;QACxD,MAAM,IAAI,GAAI,GAA0B,CAAC,eAAe,CAAC;QACzD,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAe,CAAC,CAAC;QACvE,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QAC3B,CAAC;IACL,CAAC;IAED,MAAM,CAAC,GAAW;QACd,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,UAAU,CAAC,CAAS;QAChB,MAAM,GAAG,GAAa,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3C,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAED,SAAS,CAAC,KAA8B;QACpC,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAkC,CAAC;QACxE,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC;QAC9B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAE,IAA0B,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/F,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAClD,CAAC;QACD,MAAM,IAAI,GAAI,IAA2B,CAAC,GAAG,CAAC;QAE9C,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC7C,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAChD,MAAM,WAAW,GAAG,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACjE,MAAM,UAAU,GAAG,WAAW,CAAC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEhE,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3C,IAAI,KAAK,GAAG,KAAK,CAAC;YAElB,IAAI,WAAW,EAAE,CAAC;gBACd,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;gBACrE,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBACxC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBACrB,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5C,CAAC;YACL,CAAC;iBAAM,IAAI,UAAU,EAAE,CAAC;gBACpB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBACtC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBACrB,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;gBACpE,CAAC;YACL,CAAC;iBAAM,IAAI,aAAa,EAAE,CAAC;gBACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBACtC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBACxC,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAA8B,CAAC,CAAC;oBACzD,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7C,CAAC;YACL,CAAC;iBAAM,IAAI,eAAe,EAAE,CAAC;gBACzB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBACtC,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAA8B,CAAC,CAAC;oBAC7D,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;gBACrE,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACvC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACR,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrB,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,OAAO,CAAC,IAAa,EAAE,IAAY;QACvC,IAAI,CAAC,IAAI,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClG,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE/B,IAAI,GAAG,GAAY,IAAI,CAAC;QACxB,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE,CAAC;YAC1B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;gBACd,OAAO,SAAS,CAAC;YACrB,CAAC;YAED,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;YAEzD,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;gBACf,SAAS;YACb,CAAC;YAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC1B,GAAG,GAAI,GAA+B,CAAC,OAAO,CAAC,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACJ,OAAO,SAAS,CAAC;YACrB,CAAC;QACL,CAAC;QACD,OAAO,GAAG,CAAC;IACf,CAAC"}

package/dist/types/gatekeeper-client.d.ts

@@ -37,4 +37,9 @@ export default class GatekeeperClient implements GatekeeperInterface {
     getBlock(registry: string, block?: BlockId): Promise<BlockInfo | null>;
     addBlock(registry: string, block: BlockInfo): Promise<boolean>;
     generateDID(operation: Operation): Promise<string>;
+    searchDocs(q: string): Promise<string[]>;
+    queryDocs(where: Record<string, unknown>): Promise<string[]>;
+    search(query: {
+        where: Record<string, unknown>;
+    }): Promise<string[]>;
 }

package/dist/types/gatekeeper.d.ts

@@ -1,4 +1,4 @@
-import { BatchMetadata, BlockId, BlockInfo, CheckDIDsOptions, GatekeeperInterface, GatekeeperEvent, GatekeeperOptions, ImportEventsResult, Operation, DidCidDocument, ResolveDIDOptions, GetDIDOptions, CheckDIDsResult, ImportBatchResult, ProcessEventsResult, VerifyDbResult, Signature } from './types.js';
+import { BatchMetadata, BlockId, BlockInfo, CheckDIDsOptions, GatekeeperInterface, GatekeeperEvent, GatekeeperOptions, ImportEventsResult, Operation, DidCidDocument, ResolveDIDOptions, GetDIDOptions, CheckDIDsResult, ImportBatchResult, ProcessEventsResult, VerifyDbResult, Proof } from './types.js';
 declare enum ImportStatus {
     ADDED = "added",
     MERGED = "merged",
@@ -18,7 +18,10 @@ export default class Gatekeeper implements GatekeeperInterface {
     private readonly maxQueueSize;
     supportedRegistries: string[];
     private didLocks;
+    private searchIndex;
     constructor(options: GatekeeperOptions);
+    initSearchIndex(): Promise<void>;
+    private updateSearchIndex;
     private withDidLock;
     verifyDb(options?: {
         chatty?: boolean;
@@ -32,7 +35,7 @@ export default class Gatekeeper implements GatekeeperInterface {
     verifyDIDFormat(did: string): boolean;
     verifyDateFormat(time?: string): boolean;
     verifyHashFormat(hash: string): boolean;
-    verifySignatureFormat(signature?: Signature): boolean;
+    verifyProofFormat(proof?: Proof): boolean;
     verifyCreateOperation(operation: Operation): Promise<boolean>;
     verifyUpdateOperation(operation: Operation, doc: DidCidDocument): Promise<boolean>;
     queueOperation(registry: string, operation: Operation): Promise<void>;
@@ -63,5 +66,10 @@ export default class Gatekeeper implements GatekeeperInterface {
     getData(cid: string): Promise<Buffer | null>;
     addJSON(json: object): Promise<string>;
     getJSON(cid: string): Promise<object | null>;
+    searchDocs(q: string): Promise<string[]>;
+    queryDocs(where: Record<string, unknown>): Promise<string[]>;
+    search(query: {
+        where: Record<string, unknown>;
+    }): Promise<string[]>;
 }
 export {};

package/dist/types/search-index.d.ts

@@ -0,0 +1,12 @@
+export default class SearchIndex {
+    private docs;
+    private static readonly ARRAY_WILDCARD_END;
+    private static readonly ARRAY_WILDCARD_MID;
+    store(did: string, doc: object): void;
+    delete(did: string): void;
+    clear(): void;
+    get size(): number;
+    searchDocs(q: string): string[];
+    queryDocs(where: Record<string, unknown>): string[];
+    private getPath;
+}

package/dist/types/types.d.ts

@@ -148,6 +148,11 @@ export interface GatekeeperInterface {
     getBlock(registry: string, block?: BlockId): Promise<BlockInfo | null>;
     addBlock(registry: string, block: BlockInfo): Promise<boolean>;
     generateDID(operation: Operation): Promise<string>;
+    searchDocs(q: string): Promise<string[]>;
+    queryDocs(where: Record<string, unknown>): Promise<string[]>;
+    search(query: {
+        where: Record<string, unknown>;
+    }): Promise<string[]>;
 }
 export interface DidRegistration {
     height?: number;
@@ -171,7 +176,8 @@ export interface DocumentMetadata {
     updated?: string;
     canonicalId?: string;
     versionId?: string;
-    version?: string;
+    versionSequence?: string;
+    version?: number;
     confirmed?: boolean;
     deactivated?: boolean;
     deleted?: string;
@@ -189,6 +195,7 @@ export interface DidCidDocument {
             publicKeyJwk?: EcdsaJwkPublic;
         }>;
         authentication?: string[];
+        assertionMethod?: string[];
     };
     didDocumentMetadata?: DocumentMetadata;
     didResolutionMetadata?: {
@@ -199,16 +206,18 @@ export interface DidCidDocument {
     didDocumentData?: unknown;
     didDocumentRegistration?: DocumentRegistration;
 }
-export interface Signature {
-    signer?: string;
-    signed: string;
-    hash: string;
-    value: string;
+export type ProofPurpose = "assertionMethod" | "authentication";
+export interface Proof {
+    type: "EcdsaSecp256k1Signature2019";
+    created: string;
+    verificationMethod: string;
+    proofPurpose: ProofPurpose;
+    proofValue: string;
 }
 export interface Operation {
     type: 'create' | 'update' | 'delete';
     created?: string;
-    signature?: Signature;
+    proof?: Proof;
     registration?: DocumentRegistration;
     publicJwk?: EcdsaJwkPublic;
     controller?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@didcid/gatekeeper",
-  "version": "0.1.3",
+  "version": "0.3.0",
   "description": "Archon Gatekeeper",
   "type": "module",
   "module": "./dist/esm/index.js",
@@ -124,5 +124,5 @@
   "devDependencies": {
     "@rollup/plugin-json": "^6.1.0"
   },
-  "gitHead": "dd45ee46bf0bad26d796e210f7837f36a1505960"
+  "gitHead": "1563f84a36453fd632771eea93e1aa911e3ebc33"
 }