@xyo-network/archivist 2.21.23

package/dist/esm/models/Api/Reportable.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Reportable.js.map

package/dist/esm/models/Api/Reportable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Reportable.js","sourceRoot":"","sources":["../../../../src/models/Api/Reportable.ts"],"names":[],"mappings":""}

package/dist/esm/models/Api/Response.d.ts

@@ -0,0 +1,7 @@
+import { AxiosResponse } from 'axios';
+import { XyoApiEnvelope } from './Envelope';
+export declare type XyoApiResponse<T = unknown, D = unknown> = AxiosResponse<T, D>;
+export declare type XyoApiResponseBody<T> = T | undefined;
+export declare type XyoApiResponseTuple<T> = [T | undefined, XyoApiEnvelope<T | undefined>, XyoApiResponse<XyoApiEnvelope<T | undefined>>];
+export declare type XyoApiResponseTupleOrBody<T> = XyoApiResponseTuple<T> | XyoApiResponseBody<T>;
+export declare type XyoApiResponseType = 'body' | 'tuple';

package/dist/esm/models/Api/Response.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Response.js.map

package/dist/esm/models/Api/Response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Response.js","sourceRoot":"","sources":["../../../../src/models/Api/Response.ts"],"names":[],"mappings":""}

package/dist/esm/models/Api/Warning.d.ts

@@ -0,0 +1 @@
+export declare type XyoApiWarning = Error;

package/dist/esm/models/Api/Warning.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Warning.js.map

package/dist/esm/models/Api/Warning.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Warning.js","sourceRoot":"","sources":["../../../../src/models/Api/Warning.ts"],"names":[],"mappings":""}

package/dist/esm/models/Api/index.d.ts

@@ -0,0 +1,6 @@
+export * from './Config';
+export * from './Envelope';
+export * from './Error';
+export * from './Reportable';
+export * from './Response';
+export * from './Warning';

package/dist/esm/models/Api/index.js

@@ -0,0 +1,7 @@
+export * from './Config';
+export * from './Envelope';
+export * from './Error';
+export * from './Reportable';
+export * from './Response';
+export * from './Warning';
+//# sourceMappingURL=index.js.map

package/dist/esm/models/Api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/Api/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA"}

package/dist/esm/models/Archive.d.ts

@@ -0,0 +1,24 @@
+import { XyoArchivePath } from './ArchivePath';
+export declare type AccessLevel = 'public' | 'private' | 'none';
+export declare type AccessType = 'read' | 'remove' | 'create' | 'list';
+export declare type ExpirationWindow = 'create' | 'read';
+export interface XyoAccessControl {
+    access?: Record<AccessType, AccessLevel>;
+    expiration?: {
+        window?: ExpirationWindow;
+        delay?: number;
+    };
+}
+export interface XyoAccessControls {
+    /**
+     * Set access controls on a per schema basis.
+     * '*' can be used as a wildcard
+     * Access control is set from a generic to specific direction if
+     * multiple wildcard versions apply to a schema
+     */
+    schema?: Record<string, XyoAccessControl>;
+}
+export interface XyoArchive extends XyoArchivePath {
+    user?: string;
+    accessControl?: XyoAccessControl | boolean;
+}

package/dist/esm/models/Archive.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Archive.js.map

package/dist/esm/models/Archive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Archive.js","sourceRoot":"","sources":["../../../src/models/Archive.ts"],"names":[],"mappings":""}

package/dist/esm/models/ArchiveKey.d.ts

@@ -0,0 +1,5 @@
+export interface XyoArchiveKey {
+    archive: string;
+    created?: number;
+    key: string;
+}

package/dist/esm/models/ArchiveKey.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ArchiveKey.js.map

package/dist/esm/models/ArchiveKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArchiveKey.js","sourceRoot":"","sources":["../../../src/models/ArchiveKey.ts"],"names":[],"mappings":""}

package/dist/esm/models/ArchivePath.d.ts

@@ -0,0 +1,3 @@
+export interface XyoArchivePath {
+    archive: string;
+}

package/dist/esm/models/ArchivePath.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ArchivePath.js.map

package/dist/esm/models/ArchivePath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArchivePath.js","sourceRoot":"","sources":["../../../src/models/ArchivePath.ts"],"names":[],"mappings":""}

package/dist/esm/models/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Api';
+export * from './Archive';
+export * from './ArchiveKey';
+export * from './ArchivePath';

package/dist/esm/models/index.js

@@ -0,0 +1,5 @@
+export * from './Api';
+export * from './Archive';
+export * from './ArchiveKey';
+export * from './ArchivePath';
+//# sourceMappingURL=index.js.map

package/dist/esm/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAA;AACrB,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA"}

package/dist/esm/objToQuery.d.ts

@@ -0,0 +1 @@
+export declare const objToQuery: (obj: Record<string, string | number | undefined>) => string;

package/dist/esm/objToQuery.js

@@ -0,0 +1,9 @@
+export const objToQuery = (obj) => {
+    return `?${Object.entries(obj)
+        .map(([key, value]) => {
+        return `${key}=${value}`;
+    })
+        .filter((value) => value !== undefined)
+        .join('&')}`;
+};
+//# sourceMappingURL=objToQuery.js.map

package/dist/esm/objToQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objToQuery.js","sourceRoot":"","sources":["../../src/objToQuery.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,GAAgD,EAAE,EAAE;IAC7E,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;SAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAA;IAC1B,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;SACtC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;AAChB,CAAC,CAAA"}

package/jest.config.cjs

@@ -0,0 +1,26 @@
+const generateJestConfig = ({ esModules }) => {
+  const esModulesList = Array.isArray(esModules) ? esModules.join('|') : esModules
+  return {
+    globals: {
+      'ts-jest': {
+        tsconfig: 'tsconfig.test.json',
+      },
+    },
+    moduleNameMapper: {
+      '^(\\.{1,2}/.*)\\.js$': '$1',
+    },
+    preset: 'ts-jest/presets/default-esm',
+    setupFiles: ['dotenv/config'],
+    setupFilesAfterEnv: ['jest-sorted', 'jest-extended/all'],
+    testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+    testTimeout: 20000,
+    transform: {
+      [`(${esModulesList}).+\\.js$`]: 'babel-jest',
+      '^.+\\.tsx?$': 'ts-jest/legacy',
+    },
+    transformIgnorePatterns: [`./node_modules/(?!${esModulesList})`],
+  }
+}
+
+// eslint-disable-next-line no-undef
+module.exports = generateJestConfig({ esModules: ['is-ip', 'ip-regex', 'lodash-es', 'uuid'] })

package/package.json

@@ -0,0 +1,66 @@
+{
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xylabs/sdk-js": "^2.6.2",
+    "@xyo-network/account": "^2.21.23",
+    "@xyo-network/boundwitness": "^2.21.23",
+    "@xyo-network/core": "^2.21.23",
+    "@xyo-network/payload": "^2.21.23",
+    "@xyo-network/typeof": "^2.21.23",
+    "axios": "^0.27.2",
+    "lru-cache": "^7.13.1",
+    "pako": "^2.0.4",
+    "uuid": "^8.3.2"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "devDependencies": {
+    "@ethersproject/wallet": "^5.6.2",
+    "@types/pako": "^2.0.0",
+    "@types/uuid": "^8.3.4",
+    "@xylabs/tsconfig": "^1.0.14",
+    "tslib": "^2.4.0"
+  },
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "name": "@xyo-network/archivist",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": true,
+  "types": "dist/esm/index.d.ts",
+  "version": "2.21.23",
+  "packageManager": "yarn@3.1.1"
+}

package/src/XyoArchivist.ts

@@ -0,0 +1,40 @@
+import { assertEx } from '@xylabs/sdk-js'
+import { XyoAccount } from '@xyo-network/account'
+import { XyoBoundWitness, XyoBoundWitnessBuilder, XyoBoundWitnessWithPartialMeta } from '@xyo-network/boundwitness'
+import { XyoPayload, XyoPayloadWithPartialMeta } from '@xyo-network/payload'
+
+import { Archivist } from './model'
+import { XyoPayloadFindFilter } from './XyoPayloadFindFilter'
+
+export abstract class XyoArchivist<TWrite extends XyoBoundWitness = XyoBoundWitnessWithPartialMeta, TRead extends XyoPayload = XyoPayloadWithPartialMeta>
+  implements Archivist<string[], TWrite, TRead | undefined, string, TRead[], XyoPayloadFindFilter>
+{
+  protected parent?: XyoArchivist
+  protected account?: XyoAccount
+  constructor(parent?: XyoArchivist, account?: XyoAccount) {
+    this.parent = parent
+    this.account = account
+  }
+  abstract insert(item: TWrite): string[] | Promise<string[]>
+  abstract find(query: XyoPayloadFindFilter): TRead[] | Promise<TRead[]>
+  abstract get(hash: string): TRead | Promise<TRead | undefined> | undefined
+  public all(): TRead[] | Promise<TRead[] | undefined> | undefined {
+    throw Error('getAll not supported')
+  }
+  public delete(_hash: string): boolean | Promise<boolean> {
+    throw Error('delete not supported')
+  }
+  public clear(): void | Promise<void> {
+    throw Error('clear not supported')
+  }
+  public async commit() {
+    const parent = assertEx(this.parent, 'Parent is required for commit')
+    const account = assertEx(this.account, 'Account is required for commit')
+    const payloads = assertEx(await parent.all(), 'Nothing to commit')
+    const builder = new XyoBoundWitnessBuilder()
+    const block = builder.payloads(payloads).witness(account).build()
+    const [hash] = await parent.insert(block)
+    await this.clear()
+    return hash
+  }
+}

package/src/XyoMemoryArchivist.ts

@@ -0,0 +1,62 @@
+import { XyoBoundWitnessWithMeta, XyoBoundWitnessWrapper } from '@xyo-network/boundwitness'
+import { XyoPayload, XyoPayloadWithPartialMeta, XyoPayloadWrapper } from '@xyo-network/payload'
+import LruCache from 'lru-cache'
+
+import { XyoArchivist } from './XyoArchivist'
+import { XyoPayloadFindFilter } from './XyoPayloadFindFilter'
+
+export class XyoMemoryArchivist extends XyoArchivist {
+  private cache: LruCache<string, XyoPayloadWithPartialMeta> = new LruCache<string, XyoPayloadWithPartialMeta>({ max: 10000 })
+
+  public delete(hash: string) {
+    return this.cache.delete(hash)
+  }
+
+  public clear() {
+    this.cache.clear()
+  }
+
+  public get(hash: string) {
+    return this.cache.get(hash) ?? this.parent?.get(hash)
+  }
+
+  public insert(payload: XyoBoundWitnessWithMeta) {
+    const wrapper = new XyoBoundWitnessWrapper(payload)
+    const payloadWithmeta = { ...payload, _hash: wrapper.hash, _timestamp: Date.now() }
+    const hashes: string[] = []
+    hashes.push(payloadWithmeta._hash)
+    this.cache.set(payloadWithmeta._hash, payloadWithmeta)
+    payload._payloads?.forEach((payload) => {
+      const wrapper = new XyoPayloadWrapper(payload)
+      const payloadWithmeta = { ...payload, _hash: wrapper.hash, _timestamp: Date.now() }
+      hashes.push(payloadWithmeta._hash)
+      this.cache.set(payloadWithmeta._hash, payloadWithmeta)
+    })
+    return hashes
+  }
+
+  public find<T extends XyoPayload = XyoPayload>(filter: XyoPayloadFindFilter): T[] {
+    const result: T[] = []
+    if (filter.type === 'schema') {
+      const filterSchema = filter.schema !== undefined ? (Array.isArray(filter.schema) ? filter.schema : [filter.schema]) : undefined
+      this.cache.forEach((value) => {
+        let match: XyoPayload | undefined = value
+        match = filterSchema === undefined || filterSchema.includes(value.schema) ? value : undefined
+        if (match) {
+          result.push(match as T)
+        }
+      })
+    }
+    if (filter.type === 'hash') {
+      const filterHash = filter.hash !== undefined ? (Array.isArray(filter.hash) ? filter.hash : [filter.hash]) : undefined
+      this.cache.forEach((value) => {
+        let match: XyoPayload | undefined = value
+        match = filterHash === undefined || filterHash.includes(new XyoPayloadWrapper(value).hash) ? value : undefined
+        if (match) {
+          result.push(match as T)
+        }
+      })
+    }
+    return result
+  }
+}

package/src/XyoPayloadFindFilter.ts

@@ -0,0 +1,7 @@
+export interface XyoPayloadFindFilter {
+  [key: string]: unknown
+  order?: 'desc' | 'asc'
+  timestamp?: number
+  limit?: number
+  schema?: string
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './model'
+export * from './XyoArchivist'
+export * from './XyoMemoryArchivist'
+export * from './XyoPayloadFindFilter'

package/src/model/Archivist.ts

@@ -0,0 +1,22 @@
+export interface QueryableArchivist<TQueryResponse, TQuery> {
+  find(query: TQuery): Promise<TQueryResponse> | TQueryResponse
+}
+export interface ReadArchivist<TReadResponse, TId = string> {
+  get(id: TId): Promise<TReadResponse | undefined> | TReadResponse | undefined
+}
+
+export interface WriteArchivist<TWriteResponse, TWrite, TId = string> {
+  insert(item: TWrite): Promise<TWriteResponse> | TWriteResponse
+  delete?(id: TId): Promise<boolean> | boolean
+  clear?(): void
+}
+
+export type ReadWriteArchivist<TWriteResponse, TWrite, TReadResponse = TWriteResponse, TId = string> = ReadArchivist<TReadResponse, TId> & WriteArchivist<TWriteResponse, TWrite>
+
+export type Archivist<TWriteResponse, TWrite, TReadResponse = TWriteResponse, TId = string, TQueryResponse = unknown, TQuery = unknown> = ReadWriteArchivist<
+  TWriteResponse,
+  TWrite,
+  TReadResponse,
+  TId
+> &
+  QueryableArchivist<TQueryResponse, TQuery>

package/src/model/index.ts

@@ -0,0 +1 @@
+export * from './Archivist'

package/typedoc.json

@@ -0,0 +1,11 @@
+{
+  "intentionallyNotExported": [
+    "WithXyoPayloadMeta",
+    "XyoPayload",
+    "XyoPayloadFull",
+    "XyoBoundWitness",
+    "XyoDataLike",
+    "Huri",
+    "XyoSchemaPayload"
+  ]
+}