@xyo-network/archivist-cookie 3.5.2 → 3.6.0-rc.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,7 +4,7 @@ import { AbstractArchivist } from '@xyo-network/archivist-abstract';
4
4
  import type { ArchivistConfig, ArchivistModuleEventData, ArchivistParams } from '@xyo-network/archivist-model';
5
5
  import type { BoundWitness } from '@xyo-network/boundwitness-model';
6
6
  import type { AnyConfigSchema } from '@xyo-network/module-model';
7
- import type { Payload, PayloadWithMeta, Schema, WithMeta } from '@xyo-network/payload-model';
7
+ import type { Payload, Schema, WithStorageMeta } from '@xyo-network/payload-model';
8
8
  export type CookieArchivistConfigSchema = 'network.xyo.archivist.cookie.config';
9
9
  export declare const CookieArchivistConfigSchema: CookieArchivistConfigSchema;
10
10
  export type CookieArchivistConfig = ArchivistConfig<{
@@ -23,12 +23,12 @@ export declare class CookieArchivist<TParams extends CookieArchivistParams, TEve
23
23
  get maxEntrySize(): number;
24
24
  get namespace(): string;
25
25
  get queries(): string[];
26
- protected allHandler(): PromisableArray<WithMeta<Payload>>;
26
+ protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;
27
27
  protected clearHandler(): void | Promise<void>;
28
- protected commitHandler(): Promise<WithMeta<BoundWitness>[]>;
28
+ protected commitHandler(): Promise<BoundWitness[]>;
29
29
  protected deleteHandler(hashes: Hash[]): Promise<Hash[]>;
30
- protected getHandler(hashes: Hash[]): Promisable<PayloadWithMeta[]>;
31
- protected insertHandler(payloads: Payload[]): Promise<WithMeta<Payload>[]>;
30
+ protected getHandler(hashes: Hash[]): Promisable<WithStorageMeta<Payload>[]>;
31
+ protected insertHandler(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]>;
32
32
  private keyFromHash;
33
33
  }
34
34
  //# sourceMappingURL=CookieArchivist.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"CookieArchivist.d.ts","sourceRoot":"","sources":["../../src/CookieArchivist.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EACV,eAAe,EAEf,wBAAwB,EACxB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAQrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EACV,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAC3C,MAAM,4BAA4B,CAAA;AAGnC,MAAM,MAAM,2BAA2B,GAAG,qCAAqC,CAAA;AAC/E,eAAO,MAAM,2BAA2B,EAAE,2BAAmE,CAAA;AAE7G,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC;IAClD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,2BAA2B,CAAA;CACpC,CAAC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,CAAA;AAE3F,qBAAa,eAAe,CAC1B,OAAO,SAAS,qBAAqB,EACrC,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAwD;IACxG,gBAAyB,mBAAmB,EAAE,MAAM,CAA8B;IAElF,IAAI,MAAM,uBAET;IAED,IAAI,UAAU,WAGb;IAED,IAAI,YAAY,WAGf;IAED,IAAI,SAAS,WAEZ;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAS/B;cAEkB,UAAU,IAAI,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;cAWhD,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAa9B,aAAa,IAAI,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;cAqBlD,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;cAapD,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,eAAe,EAAE,CAAC;cASnD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;IAoBzF,OAAO,CAAC,WAAW;CAGpB"}
1
+ {"version":3,"file":"CookieArchivist.d.ts","sourceRoot":"","sources":["../../src/CookieArchivist.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EACV,eAAe,EAEf,wBAAwB,EACxB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAQrC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAAE,eAAe,EACjC,MAAM,4BAA4B,CAAA;AAGnC,MAAM,MAAM,2BAA2B,GAAG,qCAAqC,CAAA;AAC/E,eAAO,MAAM,2BAA2B,EAAE,2BAAmE,CAAA;AAE7G,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC;IAClD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,2BAA2B,CAAA;CACpC,CAAC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,eAAe,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,CAAA;AAE3F,qBAAa,eAAe,CAC1B,OAAO,SAAS,qBAAqB,EACrC,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAwD;IACxG,gBAAyB,mBAAmB,EAAE,MAAM,CAA8B;IAElF,IAAI,MAAM,uBAET;IAED,IAAI,UAAU,WAGb;IAED,IAAI,YAAY,WAGf;IAED,IAAI,SAAS,WAEZ;IAED,IAAa,OAAO,IAAI,MAAM,EAAE,CAS/B;cAEkB,UAAU,IAAI,eAAe,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;cAWvD,YAAY,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;cAa9B,aAAa,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;cAqBxC,aAAa,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;cAapD,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;cAS5D,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;IAmBhG,OAAO,CAAC,WAAW;CAGpB"}
@@ -66,9 +66,9 @@ var CookieArchivist = class extends AbstractArchivist {
66
66
  const payloads = await this.all();
67
67
  assertEx(payloads.length > 0, () => "Nothing to commit");
68
68
  const settled = await Promise.allSettled((Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {
69
- const queryPayload = await PayloadBuilder.build({
69
+ const queryPayload = {
70
70
  schema: ArchivistInsertQuerySchema
71
- });
71
+ };
72
72
  const query = await this.bindQuery(queryPayload, payloads);
73
73
  return (await parent?.query(query[0], query[1]))?.[0];
74
74
  })).filter(exists));
@@ -98,13 +98,12 @@ var CookieArchivist = class extends AbstractArchivist {
98
98
  }
99
99
  async insertHandler(payloads) {
100
100
  try {
101
- const pairs = await PayloadBuilder.hashPairs(payloads);
102
- const resultPayloads = await Promise.all(pairs.map(async ([payload, hash]) => {
103
- const payloadWithMeta = await PayloadBuilder.build(payload);
101
+ const resultPayloads = await Promise.all(payloads.map(async (payload) => {
102
+ const payloadWithMeta = await PayloadBuilder.addSequencedStorageMeta(payload);
104
103
  const value = JSON.stringify(payloadWithMeta);
105
- assertEx(value.length < this.maxEntrySize, () => `Payload too large [${hash}, ${value.length}]`);
106
- Cookies.set(this.keyFromHash(hash), value);
107
- Cookies.set(this.keyFromHash(payload.$hash), value);
104
+ assertEx(value.length < this.maxEntrySize, () => `Payload too large [${payloadWithMeta._hash}, ${value.length}]`);
105
+ Cookies.set(this.keyFromHash(payloadWithMeta._hash), value);
106
+ Cookies.set(this.keyFromHash(payloadWithMeta._dataHash), value);
108
107
  return payloadWithMeta;
109
108
  }));
110
109
  return resultPayloads;
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/CookieArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport type { Hash } from '@xylabs/hex'\nimport type { Promisable, PromisableArray } from '@xylabs/promise'\nimport { fulfilled } from '@xylabs/promise'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport type {\n ArchivistConfig,\n ArchivistInsertQuery,\n ArchivistModuleEventData,\n ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistCommitQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n} from '@xyo-network/archivist-model'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n Payload, PayloadWithMeta, Schema, WithMeta,\n} from '@xyo-network/payload-model'\nimport Cookies from 'js-cookie'\n\nexport type CookieArchivistConfigSchema = 'network.xyo.archivist.cookie.config'\nexport const CookieArchivistConfigSchema: CookieArchivistConfigSchema = 'network.xyo.archivist.cookie.config'\n\nexport type CookieArchivistConfig = ArchivistConfig<{\n domain?: string\n maxEntries?: number\n maxEntrySize?: number\n namespace?: string\n schema: CookieArchivistConfigSchema\n}>\n\nexport type CookieArchivistParams = ArchivistParams<AnyConfigSchema<CookieArchivistConfig>>\n\nexport class CookieArchivist<\n TParams extends CookieArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, CookieArchivistConfigSchema]\n static override readonly defaultConfigSchema: Schema = CookieArchivistConfigSchema\n\n get domain() {\n return this.config?.domain\n }\n\n get maxEntries() {\n // all browsers support at least 60 cookies\n return this.config?.maxEntries ?? 60\n }\n\n get maxEntrySize() {\n // all browsers support at least 4000 length per cookie\n return this.config?.maxEntrySize ?? 4000\n }\n\n get namespace() {\n return this.config?.namespace ?? 'xyoarch'\n }\n\n override get queries(): string[] {\n return [\n ArchivistAllQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistCommitQuerySchema,\n ...super.queries,\n ]\n }\n\n protected override allHandler(): PromisableArray<WithMeta<Payload>> {\n try {\n return Object.entries(Cookies.get())\n .filter(([key]) => key.startsWith(`${this.namespace}-`))\n .map(([, value]) => JSON.parse(value))\n } catch (ex) {\n console.error(`Error: ${JSON.stringify(ex, null, 2)}`)\n throw ex\n }\n }\n\n protected override clearHandler(): void | Promise<void> {\n try {\n for (const [key] of Object.entries(Cookies.get())) {\n if (key.startsWith(`${this.namespace}-`)) {\n Cookies.remove(key)\n }\n }\n } catch (ex) {\n console.error(`Error: ${JSON.stringify(ex, null, 2)}`)\n throw ex\n }\n }\n\n protected override async commitHandler(): Promise<WithMeta<BoundWitness>[]> {\n try {\n const payloads = await this.all()\n assertEx(payloads.length > 0, () => 'Nothing to commit')\n const settled = await Promise.allSettled(\n (\n Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {\n const queryPayload: WithMeta<ArchivistInsertQuery> = await PayloadBuilder.build({ schema: ArchivistInsertQuerySchema })\n const query = await this.bindQuery(queryPayload, payloads)\n return (await parent?.query(query[0], query[1]))?.[0]\n })\n ).filter(exists),\n )\n await this.clear()\n return settled.filter(fulfilled).map(result => result.value).filter(exists)\n } catch (ex) {\n console.error(`Error: ${JSON.stringify(ex, null, 2)}`)\n throw ex\n }\n }\n\n protected override async deleteHandler(hashes: Hash[]): Promise<Hash[]> {\n const payloadPairs = await PayloadBuilder.dataHashPairs(await this.get(hashes))\n const deletedPairs = (\n await Promise.all(\n payloadPairs.map<[Payload, Hash]>(([payload, hash]) => {\n Cookies.remove(hash)\n return [payload, hash]\n }),\n )\n ).filter(exists)\n return deletedPairs.map(([, hash]) => hash)\n }\n\n protected override getHandler(hashes: Hash[]): Promisable<PayloadWithMeta[]> {\n return (\n hashes.map((hash) => {\n const cookieString = Cookies.get(this.keyFromHash(hash))\n return cookieString ? JSON.parse(cookieString) : undefined\n })\n ).filter(exists)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<WithMeta<Payload>[]> {\n try {\n const pairs = await PayloadBuilder.hashPairs(payloads)\n const resultPayloads: WithMeta<Payload>[] = await Promise.all(\n pairs.map(async ([payload, hash]) => {\n const payloadWithMeta = await PayloadBuilder.build(payload)\n const value = JSON.stringify(payloadWithMeta)\n assertEx(value.length < this.maxEntrySize, () => `Payload too large [${hash}, ${value.length}]`)\n Cookies.set(this.keyFromHash(hash), value)\n Cookies.set(this.keyFromHash(payload.$hash), value)\n return payloadWithMeta\n }),\n )\n return resultPayloads\n } catch (ex) {\n console.error(`Error: ${JSON.stringify(ex, null, 2)}`)\n throw ex\n }\n }\n\n private keyFromHash(hash: string) {\n return `${this.namespace}-${hash}`\n }\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,cAAc;AAGvB,SAASC,iBAAiB;AAC1B,SAASC,yBAAyB;AAOlC,SACEC,yBACAC,2BACAC,4BACAC,4BACAC,kCACK;AAGP,SAASC,sBAAsB;AAI/B,OAAOC,aAAa;AAGb,IAAMC,8BAA2D;AAYjE,IAAMC,kBAAN,cAGGC,kBAAAA;EA3CV,OA2CUA;;;EACR,OAAyBC,gBAA0B;OAAI,MAAMA;IAAeH;;EAC5E,OAAyBI,sBAA8BJ;EAEvD,IAAIK,SAAS;AACX,WAAO,KAAKC,QAAQD;EACtB;EAEA,IAAIE,aAAa;AAEf,WAAO,KAAKD,QAAQC,cAAc;EACpC;EAEA,IAAIC,eAAe;AAEjB,WAAO,KAAKF,QAAQE,gBAAgB;EACtC;EAEA,IAAIC,YAAY;AACd,WAAO,KAAKH,QAAQG,aAAa;EACnC;EAEA,IAAaC,UAAoB;AAC/B,WAAO;MACLC;MACAC;MACAC;MACAC;MACAC;SACG,MAAML;;EAEb;EAEmBM,aAAiD;AAClE,QAAI;AACF,aAAOC,OAAOC,QAAQC,QAAQC,IAAG,CAAA,EAC9BC,OAAO,CAAC,CAACC,GAAAA,MAASA,IAAIC,WAAW,GAAG,KAAKd,SAAS,GAAG,CAAA,EACrDe,IAAI,CAAC,CAAA,EAAGC,KAAAA,MAAWC,KAAKC,MAAMF,KAAAA,CAAAA;IACnC,SAASG,IAAI;AACXC,cAAQC,MAAM,UAAUJ,KAAKK,UAAUH,IAAI,MAAM,CAAA,CAAA,EAAI;AACrD,YAAMA;IACR;EACF;EAEmBI,eAAqC;AACtD,QAAI;AACF,iBAAW,CAACV,GAAAA,KAAQL,OAAOC,QAAQC,QAAQC,IAAG,CAAA,GAAK;AACjD,YAAIE,IAAIC,WAAW,GAAG,KAAKd,SAAS,GAAG,GAAG;AACxCU,kBAAQc,OAAOX,GAAAA;QACjB;MACF;IACF,SAASM,IAAI;AACXC,cAAQC,MAAM,UAAUJ,KAAKK,UAAUH,IAAI,MAAM,CAAA,CAAA,EAAI;AACrD,YAAMA;IACR;EACF;EAEA,MAAyBM,gBAAmD;AAC1E,QAAI;AACF,YAAMC,WAAW,MAAM,KAAKC,IAAG;AAC/BC,eAASF,SAASG,SAAS,GAAG,MAAM,mBAAA;AACpC,YAAMC,UAAU,MAAMC,QAAQC,YAE1BxB,OAAOyB,QAAQ,MAAM,KAAKC,iBAAgB,GAAIC,UAAU,CAAA,CAAE,GAAGpB,IAAI,OAAOqB,WAAAA;AACtE,cAAMC,eAA+C,MAAMC,eAAeC,MAAM;UAAEC,QAAQnC;QAA2B,CAAA;AACrH,cAAMoC,QAAQ,MAAM,KAAKC,UAAUL,cAAcX,QAAAA;AACjD,gBAAQ,MAAMU,QAAQK,MAAMA,MAAM,CAAA,GAAIA,MAAM,CAAA,CAAE,KAAK,CAAA;MACrD,CAAA,GACA7B,OAAO+B,MAAAA,CAAAA;AAEX,YAAM,KAAKC,MAAK;AAChB,aAAOd,QAAQlB,OAAOiC,SAAAA,EAAW9B,IAAI+B,CAAAA,WAAUA,OAAO9B,KAAK,EAAEJ,OAAO+B,MAAAA;IACtE,SAASxB,IAAI;AACXC,cAAQC,MAAM,UAAUJ,KAAKK,UAAUH,IAAI,MAAM,CAAA,CAAA,EAAI;AACrD,YAAMA;IACR;EACF;EAEA,MAAyB4B,cAAcC,QAAiC;AACtE,UAAMC,eAAe,MAAMX,eAAeY,cAAc,MAAM,KAAKvC,IAAIqC,MAAAA,CAAAA;AACvE,UAAMG,gBACJ,MAAMpB,QAAQJ,IACZsB,aAAalC,IAAqB,CAAC,CAACqC,SAASC,IAAAA,MAAK;AAChD3C,cAAQc,OAAO6B,IAAAA;AACf,aAAO;QAACD;QAASC;;IACnB,CAAA,CAAA,GAEFzC,OAAO+B,MAAAA;AACT,WAAOQ,aAAapC,IAAI,CAAC,CAAA,EAAGsC,IAAAA,MAAUA,IAAAA;EACxC;EAEmBC,WAAWN,QAA+C;AAC3E,WACEA,OAAOjC,IAAI,CAACsC,SAAAA;AACV,YAAME,eAAe7C,QAAQC,IAAI,KAAK6C,YAAYH,IAAAA,CAAAA;AAClD,aAAOE,eAAetC,KAAKC,MAAMqC,YAAAA,IAAgBE;IACnD,CAAA,EACA7C,OAAO+B,MAAAA;EACX;EAEA,MAAyBe,cAAchC,UAAmD;AACxF,QAAI;AACF,YAAMiC,QAAQ,MAAMrB,eAAesB,UAAUlC,QAAAA;AAC7C,YAAMmC,iBAAsC,MAAM9B,QAAQJ,IACxDgC,MAAM5C,IAAI,OAAO,CAACqC,SAASC,IAAAA,MAAK;AAC9B,cAAMS,kBAAkB,MAAMxB,eAAeC,MAAMa,OAAAA;AACnD,cAAMpC,QAAQC,KAAKK,UAAUwC,eAAAA;AAC7BlC,iBAASZ,MAAMa,SAAS,KAAK9B,cAAc,MAAM,sBAAsBsD,IAAAA,KAASrC,MAAMa,MAAM,GAAG;AAC/FnB,gBAAQqD,IAAI,KAAKP,YAAYH,IAAAA,GAAOrC,KAAAA;AACpCN,gBAAQqD,IAAI,KAAKP,YAAYJ,QAAQY,KAAK,GAAGhD,KAAAA;AAC7C,eAAO8C;MACT,CAAA,CAAA;AAEF,aAAOD;IACT,SAAS1C,IAAI;AACXC,cAAQC,MAAM,UAAUJ,KAAKK,UAAUH,IAAI,MAAM,CAAA,CAAA,EAAI;AACrD,YAAMA;IACR;EACF;EAEQqC,YAAYH,MAAc;AAChC,WAAO,GAAG,KAAKrD,SAAS,IAAIqD,IAAAA;EAC9B;AACF;","names":["assertEx","exists","fulfilled","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistCommitQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","PayloadBuilder","Cookies","CookieArchivistConfigSchema","CookieArchivist","AbstractArchivist","configSchemas","defaultConfigSchema","domain","config","maxEntries","maxEntrySize","namespace","queries","ArchivistAllQuerySchema","ArchivistDeleteQuerySchema","ArchivistClearQuerySchema","ArchivistInsertQuerySchema","ArchivistCommitQuerySchema","allHandler","Object","entries","Cookies","get","filter","key","startsWith","map","value","JSON","parse","ex","console","error","stringify","clearHandler","remove","commitHandler","payloads","all","assertEx","length","settled","Promise","allSettled","values","parentArchivists","commit","parent","queryPayload","PayloadBuilder","build","schema","query","bindQuery","exists","clear","fulfilled","result","deleteHandler","hashes","payloadPairs","dataHashPairs","deletedPairs","payload","hash","getHandler","cookieString","keyFromHash","undefined","insertHandler","pairs","hashPairs","resultPayloads","payloadWithMeta","set","$hash"]}
1
+ {"version":3,"sources":["../../src/CookieArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { exists } from '@xylabs/exists'\nimport type { Hash } from '@xylabs/hex'\nimport type { Promisable, PromisableArray } from '@xylabs/promise'\nimport { fulfilled } from '@xylabs/promise'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport type {\n ArchivistConfig,\n ArchivistInsertQuery,\n ArchivistModuleEventData,\n ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistCommitQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n} from '@xyo-network/archivist-model'\nimport type { BoundWitness } from '@xyo-network/boundwitness-model'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport { PayloadBuilder } from '@xyo-network/payload-builder'\nimport type {\n Payload, Schema, WithStorageMeta,\n} from '@xyo-network/payload-model'\nimport Cookies from 'js-cookie'\n\nexport type CookieArchivistConfigSchema = 'network.xyo.archivist.cookie.config'\nexport const CookieArchivistConfigSchema: CookieArchivistConfigSchema = 'network.xyo.archivist.cookie.config'\n\nexport type CookieArchivistConfig = ArchivistConfig<{\n domain?: string\n maxEntries?: number\n maxEntrySize?: number\n namespace?: string\n schema: CookieArchivistConfigSchema\n}>\n\nexport type CookieArchivistParams = ArchivistParams<AnyConfigSchema<CookieArchivistConfig>>\n\nexport class CookieArchivist<\n TParams extends CookieArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, CookieArchivistConfigSchema]\n static override readonly defaultConfigSchema: Schema = CookieArchivistConfigSchema\n\n get domain() {\n return this.config?.domain\n }\n\n get maxEntries() {\n // all browsers support at least 60 cookies\n return this.config?.maxEntries ?? 60\n }\n\n get maxEntrySize() {\n // all browsers support at least 4000 length per cookie\n return this.config?.maxEntrySize ?? 4000\n }\n\n get namespace() {\n return this.config?.namespace ?? 'xyoarch'\n }\n\n override get queries(): string[] {\n return [\n ArchivistAllQuerySchema,\n ArchivistDeleteQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistCommitQuerySchema,\n ...super.queries,\n ]\n }\n\n protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {\n try {\n return Object.entries(Cookies.get())\n .filter(([key]) => key.startsWith(`${this.namespace}-`))\n .map(([, value]) => JSON.parse(value))\n } catch (ex) {\n console.error(`Error: ${JSON.stringify(ex, null, 2)}`)\n throw ex\n }\n }\n\n protected override clearHandler(): void | Promise<void> {\n try {\n for (const [key] of Object.entries(Cookies.get())) {\n if (key.startsWith(`${this.namespace}-`)) {\n Cookies.remove(key)\n }\n }\n } catch (ex) {\n console.error(`Error: ${JSON.stringify(ex, null, 2)}`)\n throw ex\n }\n }\n\n protected override async commitHandler(): Promise<BoundWitness[]> {\n try {\n const payloads = await this.all()\n assertEx(payloads.length > 0, () => 'Nothing to commit')\n const settled = await Promise.allSettled(\n (\n Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {\n const queryPayload: ArchivistInsertQuery = { schema: ArchivistInsertQuerySchema }\n const query = await this.bindQuery(queryPayload, payloads)\n return (await parent?.query(query[0], query[1]))?.[0]\n })\n ).filter(exists),\n )\n await this.clear()\n return settled.filter(fulfilled).map(result => result.value).filter(exists)\n } catch (ex) {\n console.error(`Error: ${JSON.stringify(ex, null, 2)}`)\n throw ex\n }\n }\n\n protected override async deleteHandler(hashes: Hash[]): Promise<Hash[]> {\n const payloadPairs = await PayloadBuilder.dataHashPairs(await this.get(hashes))\n const deletedPairs = (\n await Promise.all(\n payloadPairs.map<[Payload, Hash]>(([payload, hash]) => {\n Cookies.remove(hash)\n return [payload, hash]\n }),\n )\n ).filter(exists)\n return deletedPairs.map(([, hash]) => hash)\n }\n\n protected override getHandler(hashes: Hash[]): Promisable<WithStorageMeta<Payload>[]> {\n return (\n hashes.map((hash) => {\n const cookieString = Cookies.get(this.keyFromHash(hash))\n return cookieString ? JSON.parse(cookieString) : undefined\n })\n ).filter(exists)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]> {\n try {\n const resultPayloads: WithStorageMeta<Payload>[] = await Promise.all(\n payloads.map(async (payload) => {\n const payloadWithMeta = await PayloadBuilder.addSequencedStorageMeta(payload)\n const value = JSON.stringify(payloadWithMeta)\n assertEx(value.length < this.maxEntrySize, () => `Payload too large [${payloadWithMeta._hash}, ${value.length}]`)\n Cookies.set(this.keyFromHash(payloadWithMeta._hash), value)\n Cookies.set(this.keyFromHash(payloadWithMeta._dataHash), value)\n return payloadWithMeta\n }),\n )\n return resultPayloads\n } catch (ex) {\n console.error(`Error: ${JSON.stringify(ex, null, 2)}`)\n throw ex\n }\n }\n\n private keyFromHash(hash: string) {\n return `${this.namespace}-${hash}`\n }\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,cAAc;AAGvB,SAASC,iBAAiB;AAC1B,SAASC,yBAAyB;AAOlC,SACEC,yBACAC,2BACAC,4BACAC,4BACAC,kCACK;AAGP,SAASC,sBAAsB;AAI/B,OAAOC,aAAa;AAGb,IAAMC,8BAA2D;AAYjE,IAAMC,kBAAN,cAGGC,kBAAAA;EA3CV,OA2CUA;;;EACR,OAAyBC,gBAA0B;OAAI,MAAMA;IAAeH;;EAC5E,OAAyBI,sBAA8BJ;EAEvD,IAAIK,SAAS;AACX,WAAO,KAAKC,QAAQD;EACtB;EAEA,IAAIE,aAAa;AAEf,WAAO,KAAKD,QAAQC,cAAc;EACpC;EAEA,IAAIC,eAAe;AAEjB,WAAO,KAAKF,QAAQE,gBAAgB;EACtC;EAEA,IAAIC,YAAY;AACd,WAAO,KAAKH,QAAQG,aAAa;EACnC;EAEA,IAAaC,UAAoB;AAC/B,WAAO;MACLC;MACAC;MACAC;MACAC;MACAC;SACG,MAAML;;EAEb;EAEmBM,aAAwD;AACzE,QAAI;AACF,aAAOC,OAAOC,QAAQC,QAAQC,IAAG,CAAA,EAC9BC,OAAO,CAAC,CAACC,GAAAA,MAASA,IAAIC,WAAW,GAAG,KAAKd,SAAS,GAAG,CAAA,EACrDe,IAAI,CAAC,CAAA,EAAGC,KAAAA,MAAWC,KAAKC,MAAMF,KAAAA,CAAAA;IACnC,SAASG,IAAI;AACXC,cAAQC,MAAM,UAAUJ,KAAKK,UAAUH,IAAI,MAAM,CAAA,CAAA,EAAI;AACrD,YAAMA;IACR;EACF;EAEmBI,eAAqC;AACtD,QAAI;AACF,iBAAW,CAACV,GAAAA,KAAQL,OAAOC,QAAQC,QAAQC,IAAG,CAAA,GAAK;AACjD,YAAIE,IAAIC,WAAW,GAAG,KAAKd,SAAS,GAAG,GAAG;AACxCU,kBAAQc,OAAOX,GAAAA;QACjB;MACF;IACF,SAASM,IAAI;AACXC,cAAQC,MAAM,UAAUJ,KAAKK,UAAUH,IAAI,MAAM,CAAA,CAAA,EAAI;AACrD,YAAMA;IACR;EACF;EAEA,MAAyBM,gBAAyC;AAChE,QAAI;AACF,YAAMC,WAAW,MAAM,KAAKC,IAAG;AAC/BC,eAASF,SAASG,SAAS,GAAG,MAAM,mBAAA;AACpC,YAAMC,UAAU,MAAMC,QAAQC,YAE1BxB,OAAOyB,QAAQ,MAAM,KAAKC,iBAAgB,GAAIC,UAAU,CAAA,CAAE,GAAGpB,IAAI,OAAOqB,WAAAA;AACtE,cAAMC,eAAqC;UAAEC,QAAQjC;QAA2B;AAChF,cAAMkC,QAAQ,MAAM,KAAKC,UAAUH,cAAcX,QAAAA;AACjD,gBAAQ,MAAMU,QAAQG,MAAMA,MAAM,CAAA,GAAIA,MAAM,CAAA,CAAE,KAAK,CAAA;MACrD,CAAA,GACA3B,OAAO6B,MAAAA,CAAAA;AAEX,YAAM,KAAKC,MAAK;AAChB,aAAOZ,QAAQlB,OAAO+B,SAAAA,EAAW5B,IAAI6B,CAAAA,WAAUA,OAAO5B,KAAK,EAAEJ,OAAO6B,MAAAA;IACtE,SAAStB,IAAI;AACXC,cAAQC,MAAM,UAAUJ,KAAKK,UAAUH,IAAI,MAAM,CAAA,CAAA,EAAI;AACrD,YAAMA;IACR;EACF;EAEA,MAAyB0B,cAAcC,QAAiC;AACtE,UAAMC,eAAe,MAAMC,eAAeC,cAAc,MAAM,KAAKtC,IAAImC,MAAAA,CAAAA;AACvE,UAAMI,gBACJ,MAAMnB,QAAQJ,IACZoB,aAAahC,IAAqB,CAAC,CAACoC,SAASC,IAAAA,MAAK;AAChD1C,cAAQc,OAAO4B,IAAAA;AACf,aAAO;QAACD;QAASC;;IACnB,CAAA,CAAA,GAEFxC,OAAO6B,MAAAA;AACT,WAAOS,aAAanC,IAAI,CAAC,CAAA,EAAGqC,IAAAA,MAAUA,IAAAA;EACxC;EAEmBC,WAAWP,QAAwD;AACpF,WACEA,OAAO/B,IAAI,CAACqC,SAAAA;AACV,YAAME,eAAe5C,QAAQC,IAAI,KAAK4C,YAAYH,IAAAA,CAAAA;AAClD,aAAOE,eAAerC,KAAKC,MAAMoC,YAAAA,IAAgBE;IACnD,CAAA,EACA5C,OAAO6B,MAAAA;EACX;EAEA,MAAyBgB,cAAc/B,UAA0D;AAC/F,QAAI;AACF,YAAMgC,iBAA6C,MAAM3B,QAAQJ,IAC/DD,SAASX,IAAI,OAAOoC,YAAAA;AAClB,cAAMQ,kBAAkB,MAAMX,eAAeY,wBAAwBT,OAAAA;AACrE,cAAMnC,QAAQC,KAAKK,UAAUqC,eAAAA;AAC7B/B,iBAASZ,MAAMa,SAAS,KAAK9B,cAAc,MAAM,sBAAsB4D,gBAAgBE,KAAK,KAAK7C,MAAMa,MAAM,GAAG;AAChHnB,gBAAQoD,IAAI,KAAKP,YAAYI,gBAAgBE,KAAK,GAAG7C,KAAAA;AACrDN,gBAAQoD,IAAI,KAAKP,YAAYI,gBAAgBI,SAAS,GAAG/C,KAAAA;AACzD,eAAO2C;MACT,CAAA,CAAA;AAEF,aAAOD;IACT,SAASvC,IAAI;AACXC,cAAQC,MAAM,UAAUJ,KAAKK,UAAUH,IAAI,MAAM,CAAA,CAAA,EAAI;AACrD,YAAMA;IACR;EACF;EAEQoC,YAAYH,MAAc;AAChC,WAAO,GAAG,KAAKpD,SAAS,IAAIoD,IAAAA;EAC9B;AACF;","names":["assertEx","exists","fulfilled","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistCommitQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","PayloadBuilder","Cookies","CookieArchivistConfigSchema","CookieArchivist","AbstractArchivist","configSchemas","defaultConfigSchema","domain","config","maxEntries","maxEntrySize","namespace","queries","ArchivistAllQuerySchema","ArchivistDeleteQuerySchema","ArchivistClearQuerySchema","ArchivistInsertQuerySchema","ArchivistCommitQuerySchema","allHandler","Object","entries","Cookies","get","filter","key","startsWith","map","value","JSON","parse","ex","console","error","stringify","clearHandler","remove","commitHandler","payloads","all","assertEx","length","settled","Promise","allSettled","values","parentArchivists","commit","parent","queryPayload","schema","query","bindQuery","exists","clear","fulfilled","result","deleteHandler","hashes","payloadPairs","PayloadBuilder","dataHashPairs","deletedPairs","payload","hash","getHandler","cookieString","keyFromHash","undefined","insertHandler","resultPayloads","payloadWithMeta","addSequencedStorageMeta","_hash","set","_dataHash"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/archivist-cookie",
3
- "version": "3.5.2",
3
+ "version": "3.6.0-rc.10",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,29 +29,30 @@
29
29
  "module": "dist/browser/index.mjs",
30
30
  "types": "dist/browser/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/assert": "^4.4.9",
33
- "@xylabs/exists": "^4.4.9",
34
- "@xylabs/hex": "^4.4.9",
35
- "@xylabs/promise": "^4.4.9",
36
- "@xyo-network/archivist-abstract": "^3.5.2",
37
- "@xyo-network/archivist-model": "^3.5.2",
38
- "@xyo-network/boundwitness-model": "^3.5.2",
39
- "@xyo-network/module-model": "^3.5.2",
40
- "@xyo-network/payload-builder": "^3.5.2",
41
- "@xyo-network/payload-model": "^3.5.2",
32
+ "@xylabs/assert": "^4.4.21",
33
+ "@xylabs/exists": "^4.4.21",
34
+ "@xylabs/hex": "^4.4.21",
35
+ "@xylabs/promise": "^4.4.21",
36
+ "@xyo-network/archivist-abstract": "^3.6.0-rc.10",
37
+ "@xyo-network/archivist-model": "^3.6.0-rc.10",
38
+ "@xyo-network/boundwitness-model": "^3.6.0-rc.10",
39
+ "@xyo-network/module-model": "^3.6.0-rc.10",
40
+ "@xyo-network/payload-builder": "^3.6.0-rc.10",
41
+ "@xyo-network/payload-model": "^3.6.0-rc.10",
42
42
  "js-cookie": "^3.0.5"
43
43
  },
44
44
  "devDependencies": {
45
45
  "@types/js-cookie": "^3.0.6",
46
- "@xylabs/delay": "^4.4.9",
47
- "@xylabs/ts-scripts-yarn3": "^4.2.4",
48
- "@xylabs/tsconfig": "^4.2.4",
49
- "@xyo-network/id-payload-plugin": "^3.5.2",
50
- "@xyo-network/payload-wrapper": "^3.5.2",
46
+ "@xylabs/delay": "^4.4.21",
47
+ "@xylabs/ts-scripts-yarn3": "^4.2.6",
48
+ "@xylabs/tsconfig": "^4.2.6",
49
+ "@xyo-network/id-payload-plugin": "^3.6.0-rc.10",
50
+ "@xyo-network/payload-wrapper": "^3.6.0-rc.10",
51
51
  "typescript": "^5.7.2",
52
- "vitest": "^2.1.5"
52
+ "vitest": "^2.1.8"
53
53
  },
54
54
  "publishConfig": {
55
55
  "access": "public"
56
- }
56
+ },
57
+ "stableVersion": "3.5.2"
57
58
  }
@@ -21,7 +21,7 @@ import type { BoundWitness } from '@xyo-network/boundwitness-model'
21
21
  import type { AnyConfigSchema } from '@xyo-network/module-model'
22
22
  import { PayloadBuilder } from '@xyo-network/payload-builder'
23
23
  import type {
24
- Payload, PayloadWithMeta, Schema, WithMeta,
24
+ Payload, Schema, WithStorageMeta,
25
25
  } from '@xyo-network/payload-model'
26
26
  import Cookies from 'js-cookie'
27
27
 
@@ -74,7 +74,7 @@ export class CookieArchivist<
74
74
  ]
75
75
  }
76
76
 
77
- protected override allHandler(): PromisableArray<WithMeta<Payload>> {
77
+ protected override allHandler(): PromisableArray<WithStorageMeta<Payload>> {
78
78
  try {
79
79
  return Object.entries(Cookies.get())
80
80
  .filter(([key]) => key.startsWith(`${this.namespace}-`))
@@ -98,14 +98,14 @@ export class CookieArchivist<
98
98
  }
99
99
  }
100
100
 
101
- protected override async commitHandler(): Promise<WithMeta<BoundWitness>[]> {
101
+ protected override async commitHandler(): Promise<BoundWitness[]> {
102
102
  try {
103
103
  const payloads = await this.all()
104
104
  assertEx(payloads.length > 0, () => 'Nothing to commit')
105
105
  const settled = await Promise.allSettled(
106
106
  (
107
107
  Object.values((await this.parentArchivists()).commit ?? [])?.map(async (parent) => {
108
- const queryPayload: WithMeta<ArchivistInsertQuery> = await PayloadBuilder.build({ schema: ArchivistInsertQuerySchema })
108
+ const queryPayload: ArchivistInsertQuery = { schema: ArchivistInsertQuerySchema }
109
109
  const query = await this.bindQuery(queryPayload, payloads)
110
110
  return (await parent?.query(query[0], query[1]))?.[0]
111
111
  })
@@ -132,7 +132,7 @@ export class CookieArchivist<
132
132
  return deletedPairs.map(([, hash]) => hash)
133
133
  }
134
134
 
135
- protected override getHandler(hashes: Hash[]): Promisable<PayloadWithMeta[]> {
135
+ protected override getHandler(hashes: Hash[]): Promisable<WithStorageMeta<Payload>[]> {
136
136
  return (
137
137
  hashes.map((hash) => {
138
138
  const cookieString = Cookies.get(this.keyFromHash(hash))
@@ -141,16 +141,15 @@ export class CookieArchivist<
141
141
  ).filter(exists)
142
142
  }
143
143
 
144
- protected override async insertHandler(payloads: Payload[]): Promise<WithMeta<Payload>[]> {
144
+ protected override async insertHandler(payloads: Payload[]): Promise<WithStorageMeta<Payload>[]> {
145
145
  try {
146
- const pairs = await PayloadBuilder.hashPairs(payloads)
147
- const resultPayloads: WithMeta<Payload>[] = await Promise.all(
148
- pairs.map(async ([payload, hash]) => {
149
- const payloadWithMeta = await PayloadBuilder.build(payload)
146
+ const resultPayloads: WithStorageMeta<Payload>[] = await Promise.all(
147
+ payloads.map(async (payload) => {
148
+ const payloadWithMeta = await PayloadBuilder.addSequencedStorageMeta(payload)
150
149
  const value = JSON.stringify(payloadWithMeta)
151
- assertEx(value.length < this.maxEntrySize, () => `Payload too large [${hash}, ${value.length}]`)
152
- Cookies.set(this.keyFromHash(hash), value)
153
- Cookies.set(this.keyFromHash(payload.$hash), value)
150
+ assertEx(value.length < this.maxEntrySize, () => `Payload too large [${payloadWithMeta._hash}, ${value.length}]`)
151
+ Cookies.set(this.keyFromHash(payloadWithMeta._hash), value)
152
+ Cookies.set(this.keyFromHash(payloadWithMeta._dataHash), value)
154
153
  return payloadWithMeta
155
154
  }),
156
155
  )