@webiny/db 6.0.0-beta.0 β†’ 6.0.0-rc.1

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.
@@ -0,0 +1,8 @@
1
+ import type { IRegistry, IRegistryItem, IRegistryRegisterParams } from "./types.js";
2
+ export declare class DbRegistry implements IRegistry {
3
+ private readonly items;
4
+ register<T = unknown>(input: IRegistryRegisterParams<T>): void;
5
+ getOneItem<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T>;
6
+ getItem<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T> | null;
7
+ getItems<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T>[];
8
+ }
package/DbRegistry.js ADDED
@@ -0,0 +1,38 @@
1
+ export class DbRegistry {
2
+ items = {};
3
+ register(input) {
4
+ const key = `${input.app}-${input.tags.sort().join("-")}`;
5
+ if (this.items[key]) {
6
+ throw new Error(`Item with app "${input.app}" and tags "${input.tags.join(", ")}" is already registered.`);
7
+ }
8
+ this.items[key] = input;
9
+ }
10
+ getOneItem(cb) {
11
+ const item = this.getItem(cb);
12
+ if (!item) {
13
+ throw new Error("Item not found.");
14
+ }
15
+ return item;
16
+ }
17
+ getItem(cb) {
18
+ const items = this.getItems(cb);
19
+ if (items.length === 0) {
20
+ return null;
21
+ } else if (items.length > 1) {
22
+ throw new Error("More than one item found with the provided criteria.");
23
+ }
24
+ return items[0];
25
+ }
26
+ getItems(cb) {
27
+ const results = [];
28
+ for (const key in this.items) {
29
+ const item = this.items[key];
30
+ if (cb(item)) {
31
+ results.push(item);
32
+ }
33
+ }
34
+ return results;
35
+ }
36
+ }
37
+
38
+ //# sourceMappingURL=DbRegistry.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"names":["DbRegistry","items","register","input","key","app","tags","sort","join","Error","getOneItem","cb","item","getItem","getItems","length","results","push"],"sources":["DbRegistry.ts"],"sourcesContent":["import type { IRegistry, IRegistryItem, IRegistryRegisterParams } from \"./types.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\n\nexport class DbRegistry implements IRegistry {\n private readonly items: GenericRecord<string, IRegistryItem> = {};\n\n public register<T = unknown>(input: IRegistryRegisterParams<T>): void {\n const key = `${input.app}-${input.tags.sort().join(\"-\")}`;\n\n if (this.items[key]) {\n throw new Error(\n `Item with app \"${input.app}\" and tags \"${input.tags.join(\n \", \"\n )}\" is already registered.`\n );\n }\n this.items[key] = input;\n }\n\n public getOneItem<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T> {\n const item = this.getItem(cb);\n if (!item) {\n throw new Error(\"Item not found.\");\n }\n return item;\n }\n\n public getItem<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T> | null {\n const items = this.getItems(cb);\n if (items.length === 0) {\n return null;\n } else if (items.length > 1) {\n throw new Error(\"More than one item found with the provided criteria.\");\n }\n return items[0];\n }\n\n public getItems<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T>[] {\n const results: IRegistryItem<T>[] = [];\n for (const key in this.items) {\n const item = this.items[key] as IRegistryItem<T>;\n if (cb(item)) {\n results.push(item);\n }\n }\n\n return results;\n }\n}\n"],"mappings":"AAGA,OAAO,MAAMA,UAAU,CAAsB;EACxBC,KAAK,GAAyC,CAAC,CAAC;EAE1DC,QAAQA,CAAcC,KAAiC,EAAQ;IAClE,MAAMC,GAAG,GAAG,GAAGD,KAAK,CAACE,GAAG,IAAIF,KAAK,CAACG,IAAI,CAACC,IAAI,CAAC,CAAC,CAACC,IAAI,CAAC,GAAG,CAAC,EAAE;IAEzD,IAAI,IAAI,CAACP,KAAK,CAACG,GAAG,CAAC,EAAE;MACjB,MAAM,IAAIK,KAAK,CACX,kBAAkBN,KAAK,CAACE,GAAG,eAAeF,KAAK,CAACG,IAAI,CAACE,IAAI,CACrD,IACJ,CAAC,0BACL,CAAC;IACL;IACA,IAAI,CAACP,KAAK,CAACG,GAAG,CAAC,GAAGD,KAAK;EAC3B;EAEOO,UAAUA,CAAcC,EAAuC,EAAoB;IACtF,MAAMC,IAAI,GAAG,IAAI,CAACC,OAAO,CAACF,EAAE,CAAC;IAC7B,IAAI,CAACC,IAAI,EAAE;MACP,MAAM,IAAIH,KAAK,CAAC,iBAAiB,CAAC;IACtC;IACA,OAAOG,IAAI;EACf;EAEOC,OAAOA,CAAcF,EAAuC,EAA2B;IAC1F,MAAMV,KAAK,GAAG,IAAI,CAACa,QAAQ,CAACH,EAAE,CAAC;IAC/B,IAAIV,KAAK,CAACc,MAAM,KAAK,CAAC,EAAE;MACpB,OAAO,IAAI;IACf,CAAC,MAAM,IAAId,KAAK,CAACc,MAAM,GAAG,CAAC,EAAE;MACzB,MAAM,IAAIN,KAAK,CAAC,sDAAsD,CAAC;IAC3E;IACA,OAAOR,KAAK,CAAC,CAAC,CAAC;EACnB;EAEOa,QAAQA,CAAcH,EAAuC,EAAsB;IACtF,MAAMK,OAA2B,GAAG,EAAE;IACtC,KAAK,MAAMZ,GAAG,IAAI,IAAI,CAACH,KAAK,EAAE;MAC1B,MAAMW,IAAI,GAAG,IAAI,CAACX,KAAK,CAACG,GAAG,CAAqB;MAChD,IAAIO,EAAE,CAACC,IAAI,CAAC,EAAE;QACVI,OAAO,CAACC,IAAI,CAACL,IAAI,CAAC;MACtB;IACJ;IAEA,OAAOI,OAAO;EAClB;AACJ","ignoreList":[]}
package/README.md CHANGED
@@ -1,20 +1,11 @@
1
1
  # @webiny/db
2
- [![](https://img.shields.io/npm/dw/webiny-data.svg)](https://www.npmjs.com/package/webiny-data)
3
- [![](https://img.shields.io/npm/v/webiny-data.svg)](https://www.npmjs.com/package/webiny-data)
4
- [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
5
- [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
6
2
 
7
- A set of frequently used data higher order functions.
3
+ > [!NOTE]
4
+ > This package is part of the [Webiny](https://www.webiny.com) monorepo.
5
+ > It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
8
6
 
9
- For more information, please visit
10
- [the official docs](https://github.com/doitadrian/data).
11
-
12
- ## Install
13
- ```
14
- npm install --save @webiny/db
15
- ```
7
+ πŸ“˜ **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
16
8
 
17
- Or if you prefer yarn:
18
- ```
19
- yarn add @webiny/db
20
- ```
9
+ ---
10
+
11
+ _This README file is automatically generated during the publish process._
package/index.d.ts CHANGED
@@ -1,77 +1,18 @@
1
- /**
2
- * TODO Remove when moved all packages to standalone storage opts.
3
- */
4
- interface KeyField {
5
- name: string;
1
+ import { DbRegistry } from "./DbRegistry.js";
2
+ import type { IStore } from "./store/types.js";
3
+ export * from "./types.js";
4
+ export interface DbDriver<T> extends IStore {
5
+ getClient(): T;
6
6
  }
7
- export interface Key {
8
- primary?: boolean;
9
- unique?: boolean;
10
- name: string;
11
- fields: KeyField[];
12
- }
13
- export interface ArgsBatch {
14
- instance: Batch;
15
- operation: Operation;
16
- }
17
- export interface Args {
18
- __batch?: ArgsBatch;
19
- table?: string;
20
- meta?: boolean;
21
- limit?: number;
22
- sort?: Record<string, 1 | -1>;
23
- data?: Record<string, any>;
24
- query?: Record<string, any>;
25
- keys?: Key[];
26
- }
27
- export declare type Result<T = any> = [T, Record<string, any>];
28
- export interface DbDriver {
29
- create: (args: Args) => Promise<Result<true>>;
30
- read: <T = Record<string, any>>(args: Args) => Promise<Result<T[]>>;
31
- update: (args: Args) => Promise<Result<true>>;
32
- delete: (args: Args) => Promise<Result<true>>;
33
- createLog: (args: {
34
- operation: string;
35
- data: Args;
36
- table: string;
37
- id: string;
38
- }) => Promise<Result<true>>;
39
- readLogs: <T = Record<string, any>>(args: {
40
- table: string;
41
- }) => Promise<Result<T[]>>;
42
- }
43
- export declare type OperationType = "create" | "read" | "update" | "delete";
44
- export declare type Operation = [OperationType, Args];
45
- export declare type ConstructorArgs = {
46
- driver: DbDriver;
7
+ export interface ConstructorArgs<T> {
8
+ driver: DbDriver<T>;
47
9
  table?: string;
48
- logTable?: string;
49
- };
50
- declare class Db {
51
- driver: DbDriver;
52
- table: string;
53
- logTable?: string;
54
- constructor({ driver, table, logTable }: ConstructorArgs);
55
- create(args: Args): Promise<Result<true>>;
56
- read<T = Record<string, any>>(args: Args): Promise<Result<T[]>>;
57
- update(args: Args): Promise<Result<true>>;
58
- delete(args: Args): Promise<Result<true>>;
59
- createLog(operation: string, args: Args): Promise<Result<true> | null>;
60
- readLogs<T = Record<string, any>>(): Promise<Result<T[]> | null>;
61
- batch<T0 = any, T1 = any, T2 = any, T3 = any, T4 = any, T5 = any, T6 = any, T7 = any, T8 = any, T9 = any>(): Batch;
62
10
  }
63
- declare class Batch<T0 = any, T1 = any, T2 = any, T3 = any, T4 = any, T5 = any, T6 = any, T7 = any, T8 = any, T9 = any> {
64
- db: Db;
65
- type: "batch" | "transaction";
66
- id: string;
67
- meta: Record<string, any>;
68
- operations: Operation[];
69
- constructor(db: Db);
70
- push(...operations: Operation[]): this;
71
- create(...args: Args[]): this;
72
- read(...args: Args[]): this;
73
- update(...args: Args[]): this;
74
- delete(...args: Args[]): this;
75
- execute(): Promise<[T0?, T1?, T2?, T3?, T4?, T5?, T6?, T7?, T8?, T9?]>;
11
+ declare class Db<T> {
12
+ driver: DbDriver<T>;
13
+ readonly table?: string;
14
+ readonly store: IStore;
15
+ readonly registry: DbRegistry;
16
+ constructor({ driver, table }: ConstructorArgs<T>);
76
17
  }
77
- export { Batch, Db };
18
+ export { Db };
package/index.js CHANGED
@@ -1,172 +1,19 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.Db = exports.Batch = void 0;
7
- /**
8
- * TODO Remove when moved all packages to standalone storage opts.
9
- */
10
-
11
- // Generates a short and sortable ID, e.g. "1607677774994.tfz58m".
12
- const shortId = () => {
13
- const time = new Date().getTime();
14
- const uniqueId = Math.random().toString(36).slice(-6);
15
- return `${time}.${uniqueId}`;
16
- };
17
- // Picks necessary data from received args, ready to be stored in the log table.
18
- const getCreateLogData = args => {
19
- const {
20
- table,
21
- meta,
22
- limit,
23
- sort,
24
- data,
25
- query,
26
- keys
27
- } = args;
28
- return {
29
- table,
30
- meta,
31
- limit,
32
- sort,
33
- data,
34
- query,
35
- keys,
36
- batch: args.__batch ? {
37
- id: args.__batch.instance.id,
38
- type: args.__batch.instance.type
39
- } : null
40
- };
41
- };
1
+ import { DbRegistry } from "./DbRegistry.js";
2
+ import { Store } from "./store/Store.js";
3
+ export * from "./types.js";
42
4
  class Db {
5
+ registry = new DbRegistry();
43
6
  constructor({
44
7
  driver,
45
- table,
46
- logTable
8
+ table
47
9
  }) {
48
- this.driver = driver;
49
- // @ts-expect-error
50
10
  this.table = table;
51
- this.logTable = logTable;
52
- }
53
- async create(args) {
54
- const createArgs = {
55
- ...args,
56
- table: args.table || this.table
57
- };
58
- await this.createLog("create", createArgs);
59
- return this.driver.create(createArgs);
60
- }
61
- async read(args) {
62
- const readArgs = {
63
- ...args,
64
- table: args.table || this.table
65
- };
66
- await this.createLog("read", readArgs);
67
- return this.driver.read(readArgs);
68
- }
69
- async update(args) {
70
- const updateArgs = {
71
- ...args,
72
- table: args.table || this.table
73
- };
74
- await this.createLog("update", updateArgs);
75
- return this.driver.update(updateArgs);
76
- }
77
- async delete(args) {
78
- const deleteArgs = {
79
- ...args,
80
- table: args.table || this.table
81
- };
82
- await this.createLog("delete", deleteArgs);
83
- return this.driver.delete(deleteArgs);
84
- }
85
-
86
- // Logging functions.
87
- async createLog(operation, args) {
88
- if (!this.logTable) {
89
- return null;
90
- }
91
- const data = getCreateLogData(args);
92
- return this.driver.createLog({
93
- operation,
94
- data,
95
- table: this.logTable,
96
- id: shortId()
97
- });
98
- }
99
- async readLogs() {
100
- if (!this.logTable) {
101
- return null;
102
- }
103
- return this.driver.readLogs({
104
- table: this.logTable
11
+ this.driver = driver;
12
+ this.store = new Store({
13
+ driver
105
14
  });
106
15
  }
107
- batch() {
108
- return new Batch(this);
109
- }
110
- }
111
- exports.Db = Db;
112
- class Batch {
113
- constructor(db) {
114
- this.db = db;
115
- this.type = "batch";
116
- this.id = shortId();
117
- this.meta = {};
118
- this.operations = [];
119
- }
120
- push(...operations) {
121
- for (let i = 0; i < operations.length; i++) {
122
- const item = operations[i];
123
- this.operations.push(item);
124
- }
125
- return this;
126
- }
127
- create(...args) {
128
- for (let i = 0; i < args.length; i++) {
129
- this.push(["create", args[i]]);
130
- }
131
- return this;
132
- }
133
- read(...args) {
134
- for (let i = 0; i < args.length; i++) {
135
- this.push(["read", args[i]]);
136
- }
137
- return this;
138
- }
139
- update(...args) {
140
- for (let i = 0; i < args.length; i++) {
141
- this.push(["update", args[i]]);
142
- }
143
- return this;
144
- }
145
- delete(...args) {
146
- for (let i = 0; i < args.length; i++) {
147
- this.push(["delete", args[i]]);
148
- }
149
- return this;
150
- }
151
- async execute() {
152
- /**
153
- * TODO: figure out which exact type to use instead of any.
154
- */
155
- const promises = [];
156
- for (let i = 0; i < this.operations.length; i++) {
157
- const [operation, args] = this.operations[i];
158
- promises.push(this.db[operation]({
159
- ...args,
160
- __batch: {
161
- instance: this,
162
- operation: this.operations[i]
163
- }
164
- }));
165
- }
166
- const result = Promise.all(promises);
167
- return result;
168
- }
169
16
  }
170
- exports.Batch = Batch;
17
+ export { Db };
171
18
 
172
19
  //# sourceMappingURL=index.js.map
package/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"names":["shortId","time","Date","getTime","uniqueId","Math","random","toString","slice","getCreateLogData","args","table","meta","limit","sort","data","query","keys","batch","__batch","id","instance","type","Db","constructor","driver","logTable","create","createArgs","createLog","read","readArgs","update","updateArgs","delete","deleteArgs","operation","readLogs","Batch","exports","db","operations","push","i","length","item","execute","promises","result","Promise","all"],"sources":["index.ts"],"sourcesContent":["/**\n * TODO Remove when moved all packages to standalone storage opts.\n */\ninterface KeyField {\n name: string;\n}\n\nexport interface Key {\n primary?: boolean;\n unique?: boolean;\n name: string;\n fields: KeyField[];\n}\n\nexport interface ArgsBatch {\n instance: Batch;\n operation: Operation;\n}\nexport interface Args {\n __batch?: ArgsBatch;\n table?: string;\n meta?: boolean;\n limit?: number;\n sort?: Record<string, 1 | -1>;\n data?: Record<string, any>;\n query?: Record<string, any>;\n keys?: Key[];\n}\n\nexport type Result<T = any> = [T, Record<string, any>];\n\nexport interface DbDriver {\n create: (args: Args) => Promise<Result<true>>;\n read: <T = Record<string, any>>(args: Args) => Promise<Result<T[]>>;\n update: (args: Args) => Promise<Result<true>>;\n delete: (args: Args) => Promise<Result<true>>;\n\n // Logging functions.\n createLog: (args: {\n operation: string;\n data: Args;\n table: string;\n id: string;\n }) => Promise<Result<true>>;\n readLogs: <T = Record<string, any>>(args: { table: string }) => Promise<Result<T[]>>;\n}\n\nexport type OperationType = \"create\" | \"read\" | \"update\" | \"delete\";\nexport type Operation = [OperationType, Args];\n\nexport type ConstructorArgs = {\n driver: DbDriver;\n table?: string;\n logTable?: string;\n};\n\n// Generates a short and sortable ID, e.g. \"1607677774994.tfz58m\".\nconst shortId = () => {\n const time = new Date().getTime();\n const uniqueId = Math.random().toString(36).slice(-6);\n\n return `${time}.${uniqueId}`;\n};\n\ninterface LogDataBatch {\n id: string;\n type: string;\n}\ninterface LogData\n extends Pick<Args, \"table\" | \"meta\" | \"limit\" | \"sort\" | \"data\" | \"query\" | \"keys\"> {\n batch: LogDataBatch | null;\n}\n\n// Picks necessary data from received args, ready to be stored in the log table.\nconst getCreateLogData = (args: Args): LogData => {\n const { table, meta, limit, sort, data, query, keys } = args;\n\n return {\n table,\n meta,\n limit,\n sort,\n data,\n query,\n keys,\n batch: args.__batch\n ? {\n id: args.__batch.instance.id,\n type: args.__batch.instance.type\n }\n : null\n };\n};\n\nclass Db {\n public driver: DbDriver;\n public table: string;\n public logTable?: string;\n\n constructor({ driver, table, logTable }: ConstructorArgs) {\n this.driver = driver;\n // @ts-expect-error\n this.table = table;\n this.logTable = logTable;\n }\n\n public async create(args: Args): Promise<Result<true>> {\n const createArgs = { ...args, table: args.table || this.table };\n await this.createLog(\"create\", createArgs);\n return this.driver.create(createArgs);\n }\n\n public async read<T = Record<string, any>>(args: Args): Promise<Result<T[]>> {\n const readArgs = { ...args, table: args.table || this.table };\n await this.createLog(\"read\", readArgs);\n return this.driver.read(readArgs);\n }\n\n public async update(args: Args): Promise<Result<true>> {\n const updateArgs = { ...args, table: args.table || this.table };\n await this.createLog(\"update\", updateArgs);\n return this.driver.update(updateArgs);\n }\n\n public async delete(args: Args): Promise<Result<true>> {\n const deleteArgs = { ...args, table: args.table || this.table };\n await this.createLog(\"delete\", deleteArgs);\n return this.driver.delete(deleteArgs);\n }\n\n // Logging functions.\n public async createLog(operation: string, args: Args): Promise<Result<true> | null> {\n if (!this.logTable) {\n return null;\n }\n\n const data = getCreateLogData(args);\n return this.driver.createLog({ operation, data, table: this.logTable, id: shortId() });\n }\n\n public async readLogs<T = Record<string, any>>(): Promise<Result<T[]> | null> {\n if (!this.logTable) {\n return null;\n }\n\n return this.driver.readLogs({\n table: this.logTable\n });\n }\n\n public batch<\n T0 = any,\n T1 = any,\n T2 = any,\n T3 = any,\n T4 = any,\n T5 = any,\n T6 = any,\n T7 = any,\n T8 = any,\n T9 = any\n >(): Batch {\n return new Batch<T0, T1, T2, T3, T4, T5, T6, T7, T8, T9>(this);\n }\n}\n\nclass Batch<\n T0 = any,\n T1 = any,\n T2 = any,\n T3 = any,\n T4 = any,\n T5 = any,\n T6 = any,\n T7 = any,\n T8 = any,\n T9 = any\n> {\n db: Db;\n type: \"batch\" | \"transaction\";\n id: string;\n meta: Record<string, any>;\n operations: Operation[];\n\n constructor(db: Db) {\n this.db = db;\n this.type = \"batch\";\n this.id = shortId();\n\n this.meta = {};\n this.operations = [];\n }\n\n push(...operations: Operation[]) {\n for (let i = 0; i < operations.length; i++) {\n const item = operations[i];\n this.operations.push(item);\n }\n return this;\n }\n\n create(...args: Args[]) {\n for (let i = 0; i < args.length; i++) {\n this.push([\"create\", args[i]]);\n }\n return this;\n }\n\n read(...args: Args[]) {\n for (let i = 0; i < args.length; i++) {\n this.push([\"read\", args[i]]);\n }\n return this;\n }\n\n update(...args: Args[]) {\n for (let i = 0; i < args.length; i++) {\n this.push([\"update\", args[i]]);\n }\n return this;\n }\n\n delete(...args: Args[]) {\n for (let i = 0; i < args.length; i++) {\n this.push([\"delete\", args[i]]);\n }\n return this;\n }\n\n async execute(): Promise<[T0?, T1?, T2?, T3?, T4?, T5?, T6?, T7?, T8?, T9?]> {\n /**\n * TODO: figure out which exact type to use instead of any.\n */\n const promises: Promise<any>[] = [];\n for (let i = 0; i < this.operations.length; i++) {\n const [operation, args] = this.operations[i];\n promises.push(\n this.db[operation]({\n ...args,\n __batch: {\n instance: this,\n operation: this.operations[i]\n }\n })\n );\n }\n\n const result = Promise.all(promises);\n\n return result as Promise<[T0?, T1?, T2?, T3?, T4?, T5?, T6?, T7?, T8?, T9?]>;\n }\n}\n\nexport { Batch, Db };\n"],"mappings":";;;;;;AAAA;AACA;AACA;;AAsDA;AACA,MAAMA,OAAO,GAAGA,CAAA,KAAM;EAClB,MAAMC,IAAI,GAAG,IAAIC,IAAI,CAAC,CAAC,CAACC,OAAO,CAAC,CAAC;EACjC,MAAMC,QAAQ,GAAGC,IAAI,CAACC,MAAM,CAAC,CAAC,CAACC,QAAQ,CAAC,EAAE,CAAC,CAACC,KAAK,CAAC,CAAC,CAAC,CAAC;EAErD,OAAQ,GAAEP,IAAK,IAAGG,QAAS,EAAC;AAChC,CAAC;AAWD;AACA,MAAMK,gBAAgB,GAAIC,IAAU,IAAc;EAC9C,MAAM;IAAEC,KAAK;IAAEC,IAAI;IAAEC,KAAK;IAAEC,IAAI;IAAEC,IAAI;IAAEC,KAAK;IAAEC;EAAK,CAAC,GAAGP,IAAI;EAE5D,OAAO;IACHC,KAAK;IACLC,IAAI;IACJC,KAAK;IACLC,IAAI;IACJC,IAAI;IACJC,KAAK;IACLC,IAAI;IACJC,KAAK,EAAER,IAAI,CAACS,OAAO,GACb;MACIC,EAAE,EAAEV,IAAI,CAACS,OAAO,CAACE,QAAQ,CAACD,EAAE;MAC5BE,IAAI,EAAEZ,IAAI,CAACS,OAAO,CAACE,QAAQ,CAACC;IAChC,CAAC,GACD;EACV,CAAC;AACL,CAAC;AAED,MAAMC,EAAE,CAAC;EAKLC,WAAWA,CAAC;IAAEC,MAAM;IAAEd,KAAK;IAAEe;EAA0B,CAAC,EAAE;IACtD,IAAI,CAACD,MAAM,GAAGA,MAAM;IACpB;IACA,IAAI,CAACd,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACe,QAAQ,GAAGA,QAAQ;EAC5B;EAEA,MAAaC,MAAMA,CAACjB,IAAU,EAAyB;IACnD,MAAMkB,UAAU,GAAG;MAAE,GAAGlB,IAAI;MAAEC,KAAK,EAAED,IAAI,CAACC,KAAK,IAAI,IAAI,CAACA;IAAM,CAAC;IAC/D,MAAM,IAAI,CAACkB,SAAS,CAAC,QAAQ,EAAED,UAAU,CAAC;IAC1C,OAAO,IAAI,CAACH,MAAM,CAACE,MAAM,CAACC,UAAU,CAAC;EACzC;EAEA,MAAaE,IAAIA,CAA0BpB,IAAU,EAAwB;IACzE,MAAMqB,QAAQ,GAAG;MAAE,GAAGrB,IAAI;MAAEC,KAAK,EAAED,IAAI,CAACC,KAAK,IAAI,IAAI,CAACA;IAAM,CAAC;IAC7D,MAAM,IAAI,CAACkB,SAAS,CAAC,MAAM,EAAEE,QAAQ,CAAC;IACtC,OAAO,IAAI,CAACN,MAAM,CAACK,IAAI,CAACC,QAAQ,CAAC;EACrC;EAEA,MAAaC,MAAMA,CAACtB,IAAU,EAAyB;IACnD,MAAMuB,UAAU,GAAG;MAAE,GAAGvB,IAAI;MAAEC,KAAK,EAAED,IAAI,CAACC,KAAK,IAAI,IAAI,CAACA;IAAM,CAAC;IAC/D,MAAM,IAAI,CAACkB,SAAS,CAAC,QAAQ,EAAEI,UAAU,CAAC;IAC1C,OAAO,IAAI,CAACR,MAAM,CAACO,MAAM,CAACC,UAAU,CAAC;EACzC;EAEA,MAAaC,MAAMA,CAACxB,IAAU,EAAyB;IACnD,MAAMyB,UAAU,GAAG;MAAE,GAAGzB,IAAI;MAAEC,KAAK,EAAED,IAAI,CAACC,KAAK,IAAI,IAAI,CAACA;IAAM,CAAC;IAC/D,MAAM,IAAI,CAACkB,SAAS,CAAC,QAAQ,EAAEM,UAAU,CAAC;IAC1C,OAAO,IAAI,CAACV,MAAM,CAACS,MAAM,CAACC,UAAU,CAAC;EACzC;;EAEA;EACA,MAAaN,SAASA,CAACO,SAAiB,EAAE1B,IAAU,EAAgC;IAChF,IAAI,CAAC,IAAI,CAACgB,QAAQ,EAAE;MAChB,OAAO,IAAI;IACf;IAEA,MAAMX,IAAI,GAAGN,gBAAgB,CAACC,IAAI,CAAC;IACnC,OAAO,IAAI,CAACe,MAAM,CAACI,SAAS,CAAC;MAAEO,SAAS;MAAErB,IAAI;MAAEJ,KAAK,EAAE,IAAI,CAACe,QAAQ;MAAEN,EAAE,EAAEpB,OAAO,CAAC;IAAE,CAAC,CAAC;EAC1F;EAEA,MAAaqC,QAAQA,CAAA,EAAyD;IAC1E,IAAI,CAAC,IAAI,CAACX,QAAQ,EAAE;MAChB,OAAO,IAAI;IACf;IAEA,OAAO,IAAI,CAACD,MAAM,CAACY,QAAQ,CAAC;MACxB1B,KAAK,EAAE,IAAI,CAACe;IAChB,CAAC,CAAC;EACN;EAEOR,KAAKA,CAAA,EAWD;IACP,OAAO,IAAIoB,KAAK,CAAyC,IAAI,CAAC;EAClE;AACJ;AAACC,OAAA,CAAAhB,EAAA,GAAAA,EAAA;AAED,MAAMe,KAAK,CAWT;EAOEd,WAAWA,CAACgB,EAAM,EAAE;IAChB,IAAI,CAACA,EAAE,GAAGA,EAAE;IACZ,IAAI,CAAClB,IAAI,GAAG,OAAO;IACnB,IAAI,CAACF,EAAE,GAAGpB,OAAO,CAAC,CAAC;IAEnB,IAAI,CAACY,IAAI,GAAG,CAAC,CAAC;IACd,IAAI,CAAC6B,UAAU,GAAG,EAAE;EACxB;EAEAC,IAAIA,CAAC,GAAGD,UAAuB,EAAE;IAC7B,KAAK,IAAIE,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGF,UAAU,CAACG,MAAM,EAAED,CAAC,EAAE,EAAE;MACxC,MAAME,IAAI,GAAGJ,UAAU,CAACE,CAAC,CAAC;MAC1B,IAAI,CAACF,UAAU,CAACC,IAAI,CAACG,IAAI,CAAC;IAC9B;IACA,OAAO,IAAI;EACf;EAEAlB,MAAMA,CAAC,GAAGjB,IAAY,EAAE;IACpB,KAAK,IAAIiC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGjC,IAAI,CAACkC,MAAM,EAAED,CAAC,EAAE,EAAE;MAClC,IAAI,CAACD,IAAI,CAAC,CAAC,QAAQ,EAAEhC,IAAI,CAACiC,CAAC,CAAC,CAAC,CAAC;IAClC;IACA,OAAO,IAAI;EACf;EAEAb,IAAIA,CAAC,GAAGpB,IAAY,EAAE;IAClB,KAAK,IAAIiC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGjC,IAAI,CAACkC,MAAM,EAAED,CAAC,EAAE,EAAE;MAClC,IAAI,CAACD,IAAI,CAAC,CAAC,MAAM,EAAEhC,IAAI,CAACiC,CAAC,CAAC,CAAC,CAAC;IAChC;IACA,OAAO,IAAI;EACf;EAEAX,MAAMA,CAAC,GAAGtB,IAAY,EAAE;IACpB,KAAK,IAAIiC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGjC,IAAI,CAACkC,MAAM,EAAED,CAAC,EAAE,EAAE;MAClC,IAAI,CAACD,IAAI,CAAC,CAAC,QAAQ,EAAEhC,IAAI,CAACiC,CAAC,CAAC,CAAC,CAAC;IAClC;IACA,OAAO,IAAI;EACf;EAEAT,MAAMA,CAAC,GAAGxB,IAAY,EAAE;IACpB,KAAK,IAAIiC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGjC,IAAI,CAACkC,MAAM,EAAED,CAAC,EAAE,EAAE;MAClC,IAAI,CAACD,IAAI,CAAC,CAAC,QAAQ,EAAEhC,IAAI,CAACiC,CAAC,CAAC,CAAC,CAAC;IAClC;IACA,OAAO,IAAI;EACf;EAEA,MAAMG,OAAOA,CAAA,EAAgE;IACzE;AACR;AACA;IACQ,MAAMC,QAAwB,GAAG,EAAE;IACnC,KAAK,IAAIJ,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAG,IAAI,CAACF,UAAU,CAACG,MAAM,EAAED,CAAC,EAAE,EAAE;MAC7C,MAAM,CAACP,SAAS,EAAE1B,IAAI,CAAC,GAAG,IAAI,CAAC+B,UAAU,CAACE,CAAC,CAAC;MAC5CI,QAAQ,CAACL,IAAI,CACT,IAAI,CAACF,EAAE,CAACJ,SAAS,CAAC,CAAC;QACf,GAAG1B,IAAI;QACPS,OAAO,EAAE;UACLE,QAAQ,EAAE,IAAI;UACde,SAAS,EAAE,IAAI,CAACK,UAAU,CAACE,CAAC;QAChC;MACJ,CAAC,CACL,CAAC;IACL;IAEA,MAAMK,MAAM,GAAGC,OAAO,CAACC,GAAG,CAACH,QAAQ,CAAC;IAEpC,OAAOC,MAAM;EACjB;AACJ;AAACT,OAAA,CAAAD,KAAA,GAAAA,KAAA","ignoreList":[]}
1
+ {"version":3,"names":["DbRegistry","Store","Db","registry","constructor","driver","table","store"],"sources":["index.ts"],"sourcesContent":["import { DbRegistry } from \"~/DbRegistry.js\";\nimport type { IStore } from \"~/store/types.js\";\nimport { Store } from \"~/store/Store.js\";\n\nexport * from \"./types.js\";\n\nexport interface DbDriver<T> extends IStore {\n getClient(): T;\n}\n\nexport interface ConstructorArgs<T> {\n driver: DbDriver<T>;\n table?: string;\n}\n\nclass Db<T> {\n public driver: DbDriver<T>;\n public readonly table?: string;\n public readonly store: IStore;\n\n public readonly registry = new DbRegistry();\n\n constructor({ driver, table }: ConstructorArgs<T>) {\n this.table = table;\n this.driver = driver;\n this.store = new Store<T>({\n driver\n });\n }\n}\n\nexport { Db };\n"],"mappings":"AAAA,SAASA,UAAU;AAEnB,SAASC,KAAK;AAEd;AAWA,MAAMC,EAAE,CAAI;EAKQC,QAAQ,GAAG,IAAIH,UAAU,CAAC,CAAC;EAE3CI,WAAWA,CAAC;IAAEC,MAAM;IAAEC;EAA0B,CAAC,EAAE;IAC/C,IAAI,CAACA,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACD,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACE,KAAK,GAAG,IAAIN,KAAK,CAAI;MACtBI;IACJ,CAAC,CAAC;EACN;AACJ;AAEA,SAASH,EAAE","ignoreList":[]}
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "@webiny/db",
3
- "version": "6.0.0-beta.0",
3
+ "version": "6.0.0-rc.1",
4
+ "type": "module",
4
5
  "main": "index.js",
5
6
  "repository": {
6
7
  "type": "git",
@@ -12,17 +13,14 @@
12
13
  "access": "public",
13
14
  "directory": "dist"
14
15
  },
15
- "devDependencies": {
16
- "@babel/cli": "7.24.1",
17
- "@babel/core": "7.24.3",
18
- "@webiny/cli": "6.0.0-beta.0",
19
- "@webiny/project-utils": "6.0.0-beta.0",
20
- "rimraf": "5.0.5",
21
- "typescript": "4.7.4"
16
+ "dependencies": {
17
+ "@webiny/api": "6.0.0-rc.1",
18
+ "type-fest": "5.4.4"
22
19
  },
23
- "scripts": {
24
- "build": "yarn webiny run build",
25
- "watch": "yarn webiny run watch"
20
+ "devDependencies": {
21
+ "@webiny/build-tools": "6.0.0-rc.1",
22
+ "rimraf": "6.1.3",
23
+ "typescript": "5.9.3"
26
24
  },
27
- "gitHead": "aa8dbfbbd5ad13ec271adba6f2431e02991a300f"
25
+ "gitHead": "36d702721ff9ed39fb21d6f5fe7922a2a8716e63"
28
26
  }
@@ -0,0 +1,17 @@
1
+ import type { GetValueResult, GetValuesResult, IListValuesParams, IStore, ListValuesResult, RemoveValueResult, RemoveValuesResult, StorageKey, StoreValueResult, StoreValuesResult } from "./types.js";
2
+ import type { GenericRecord } from "@webiny/api/types.js";
3
+ import type { DbDriver } from "../index.js";
4
+ export interface IStoreParams<T> {
5
+ driver: DbDriver<T>;
6
+ }
7
+ export declare class Store<T> implements IStore {
8
+ private driver;
9
+ constructor(params: IStoreParams<T>);
10
+ storeValue<V>(key: StorageKey, value: V): Promise<StoreValueResult<V>>;
11
+ storeValues<V extends GenericRecord<StorageKey>>(values: V): Promise<StoreValuesResult<V>>;
12
+ getValue<V>(key: StorageKey): Promise<GetValueResult<V>>;
13
+ getValues<V extends GenericRecord<StorageKey>>(keys: (keyof V)[]): Promise<GetValuesResult<V>>;
14
+ listValues<V extends GenericRecord<StorageKey>>(params?: IListValuesParams): Promise<ListValuesResult<V>>;
15
+ removeValue<V>(key: StorageKey): Promise<RemoveValueResult<V>>;
16
+ removeValues<V extends GenericRecord<StorageKey>>(keys: (keyof V)[]): Promise<RemoveValuesResult<V>>;
17
+ }
package/store/Store.js ADDED
@@ -0,0 +1,28 @@
1
+ export class Store {
2
+ constructor(params) {
3
+ this.driver = params.driver;
4
+ }
5
+ async storeValue(key, value) {
6
+ return this.driver.storeValue(key, value);
7
+ }
8
+ async storeValues(values) {
9
+ return this.driver.storeValues(values);
10
+ }
11
+ async getValue(key) {
12
+ return this.driver.getValue(key);
13
+ }
14
+ async getValues(keys) {
15
+ return this.driver.getValues(keys);
16
+ }
17
+ async listValues(params) {
18
+ return this.driver.listValues(params);
19
+ }
20
+ async removeValue(key) {
21
+ return this.driver.removeValue(key);
22
+ }
23
+ async removeValues(keys) {
24
+ return this.driver.removeValues(keys);
25
+ }
26
+ }
27
+
28
+ //# sourceMappingURL=Store.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"names":["Store","constructor","params","driver","storeValue","key","value","storeValues","values","getValue","getValues","keys","listValues","removeValue","removeValues"],"sources":["Store.ts"],"sourcesContent":["import type {\n GetValueResult,\n GetValuesResult,\n IListValuesParams,\n IStore,\n ListValuesResult,\n RemoveValueResult,\n RemoveValuesResult,\n StorageKey,\n StoreValueResult,\n StoreValuesResult\n} from \"./types.js\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\nimport type { DbDriver } from \"~/index.js\";\n\nexport interface IStoreParams<T> {\n driver: DbDriver<T>;\n}\n\nexport class Store<T> implements IStore {\n private driver: DbDriver<T>;\n\n public constructor(params: IStoreParams<T>) {\n this.driver = params.driver;\n }\n\n public async storeValue<V>(key: StorageKey, value: V): Promise<StoreValueResult<V>> {\n return this.driver.storeValue<V>(key, value);\n }\n\n public async storeValues<V extends GenericRecord<StorageKey>>(\n values: V\n ): Promise<StoreValuesResult<V>> {\n return this.driver.storeValues<V>(values);\n }\n\n public async getValue<V>(key: StorageKey): Promise<GetValueResult<V>> {\n return this.driver.getValue<V>(key);\n }\n\n public async getValues<V extends GenericRecord<StorageKey>>(\n keys: (keyof V)[]\n ): Promise<GetValuesResult<V>> {\n return this.driver.getValues<V>(keys);\n }\n\n public async listValues<V extends GenericRecord<StorageKey>>(\n params?: IListValuesParams\n ): Promise<ListValuesResult<V>> {\n return this.driver.listValues<V>(params);\n }\n\n public async removeValue<V>(key: StorageKey): Promise<RemoveValueResult<V>> {\n return this.driver.removeValue<V>(key);\n }\n\n public async removeValues<V extends GenericRecord<StorageKey>>(\n keys: (keyof V)[]\n ): Promise<RemoveValuesResult<V>> {\n return this.driver.removeValues<V>(keys);\n }\n}\n"],"mappings":"AAmBA,OAAO,MAAMA,KAAK,CAAsB;EAG7BC,WAAWA,CAACC,MAAuB,EAAE;IACxC,IAAI,CAACC,MAAM,GAAGD,MAAM,CAACC,MAAM;EAC/B;EAEA,MAAaC,UAAUA,CAAIC,GAAe,EAAEC,KAAQ,EAAgC;IAChF,OAAO,IAAI,CAACH,MAAM,CAACC,UAAU,CAAIC,GAAG,EAAEC,KAAK,CAAC;EAChD;EAEA,MAAaC,WAAWA,CACpBC,MAAS,EACoB;IAC7B,OAAO,IAAI,CAACL,MAAM,CAACI,WAAW,CAAIC,MAAM,CAAC;EAC7C;EAEA,MAAaC,QAAQA,CAAIJ,GAAe,EAA8B;IAClE,OAAO,IAAI,CAACF,MAAM,CAACM,QAAQ,CAAIJ,GAAG,CAAC;EACvC;EAEA,MAAaK,SAASA,CAClBC,IAAiB,EACU;IAC3B,OAAO,IAAI,CAACR,MAAM,CAACO,SAAS,CAAIC,IAAI,CAAC;EACzC;EAEA,MAAaC,UAAUA,CACnBV,MAA0B,EACE;IAC5B,OAAO,IAAI,CAACC,MAAM,CAACS,UAAU,CAAIV,MAAM,CAAC;EAC5C;EAEA,MAAaW,WAAWA,CAAIR,GAAe,EAAiC;IACxE,OAAO,IAAI,CAACF,MAAM,CAACU,WAAW,CAAIR,GAAG,CAAC;EAC1C;EAEA,MAAaS,YAAYA,CACrBH,IAAiB,EACa;IAC9B,OAAO,IAAI,CAACR,MAAM,CAACW,YAAY,CAAIH,IAAI,CAAC;EAC5C;AACJ","ignoreList":[]}
@@ -0,0 +1,84 @@
1
+ import type { CamelCase } from "type-fest";
2
+ import type { GenericRecord } from "@webiny/api/types.js";
3
+ export type StorageKey = `${CamelCase<string>}`;
4
+ export interface IStoreValueSuccessResult<V> {
5
+ key: StorageKey;
6
+ data: V | null | undefined;
7
+ error?: undefined;
8
+ }
9
+ export interface IStoreValueErrorResult {
10
+ key: StorageKey;
11
+ data?: never;
12
+ error: Error;
13
+ }
14
+ export type StoreValueResult<V> = IStoreValueSuccessResult<V> | IStoreValueErrorResult;
15
+ export interface IStoreValuesSuccessResult<V extends GenericRecord<StorageKey>> {
16
+ keys: (keyof V)[];
17
+ data: V;
18
+ error?: undefined;
19
+ }
20
+ export interface IStoreValuesErrorResult<V> {
21
+ keys: (keyof V)[];
22
+ data?: never;
23
+ error: Error;
24
+ }
25
+ export type StoreValuesResult<V extends GenericRecord<StorageKey>> = IStoreValuesSuccessResult<V> | IStoreValuesErrorResult<V>;
26
+ export interface IGetValueSuccessResult<V> {
27
+ key: StorageKey;
28
+ data: V | null | undefined;
29
+ error?: undefined;
30
+ }
31
+ export interface IGetValueErrorResult {
32
+ key: StorageKey;
33
+ data?: never;
34
+ error: Error;
35
+ }
36
+ export type GetValueResult<V> = IGetValueSuccessResult<V> | IGetValueErrorResult;
37
+ export interface IGetValuesSuccessResult<V extends GenericRecord<StorageKey>> {
38
+ keys: (keyof V)[];
39
+ data: V;
40
+ error?: undefined;
41
+ }
42
+ export interface IGetValuesErrorResult<V> {
43
+ keys: (keyof V)[];
44
+ data?: never;
45
+ error: Error;
46
+ }
47
+ export type GetValuesResult<V extends GenericRecord<StorageKey>> = IGetValuesSuccessResult<V> | IGetValuesErrorResult<V>;
48
+ export interface IListValuesSuccessResult<V extends GenericRecord<StorageKey>> {
49
+ keys: (keyof V)[];
50
+ data: V;
51
+ error?: undefined;
52
+ }
53
+ export interface IListValuesErrorResult {
54
+ data?: never;
55
+ error: Error;
56
+ }
57
+ export type ListValuesResult<V extends GenericRecord<StorageKey>> = IListValuesSuccessResult<V> | IListValuesErrorResult;
58
+ export type IListValuesParams = {
59
+ beginsWith: string;
60
+ } | {
61
+ eq: string;
62
+ } | {
63
+ gt: string;
64
+ } | {
65
+ gte: string;
66
+ } | {
67
+ lt: string;
68
+ } | {
69
+ lte: string;
70
+ };
71
+ export type RemoveValueResult<V> = StoreValueResult<V>;
72
+ export interface RemoveValuesResult<V extends GenericRecord<StorageKey>> {
73
+ keys: (keyof V)[];
74
+ error?: Error;
75
+ }
76
+ export interface IStore {
77
+ storeValue<V>(key: StorageKey, value: V): Promise<StoreValueResult<V>>;
78
+ storeValues<V extends GenericRecord<StorageKey>>(values: V): Promise<StoreValuesResult<V>>;
79
+ getValue<V>(key: StorageKey): Promise<GetValueResult<V>>;
80
+ getValues<V extends GenericRecord<StorageKey>>(keys: (keyof V)[]): Promise<GetValuesResult<V>>;
81
+ listValues<V extends GenericRecord<StorageKey>>(params?: IListValuesParams): Promise<ListValuesResult<V>>;
82
+ removeValue<V>(key: StorageKey): Promise<RemoveValueResult<V>>;
83
+ removeValues<V extends GenericRecord<StorageKey>>(keys: (keyof V)[]): Promise<RemoveValuesResult<V>>;
84
+ }
package/store/types.js ADDED
@@ -0,0 +1,3 @@
1
+ export {};
2
+
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { CamelCase } from \"type-fest\";\nimport type { GenericRecord } from \"@webiny/api/types.js\";\n\nexport type StorageKey = `${CamelCase<string>}`;\n\nexport interface IStoreValueSuccessResult<V> {\n key: StorageKey;\n data: V | null | undefined;\n error?: undefined;\n}\n\nexport interface IStoreValueErrorResult {\n key: StorageKey;\n data?: never;\n error: Error;\n}\n\nexport type StoreValueResult<V> = IStoreValueSuccessResult<V> | IStoreValueErrorResult;\n\nexport interface IStoreValuesSuccessResult<V extends GenericRecord<StorageKey>> {\n keys: (keyof V)[];\n data: V;\n error?: undefined;\n}\n\nexport interface IStoreValuesErrorResult<V> {\n keys: (keyof V)[];\n data?: never;\n error: Error;\n}\n\nexport type StoreValuesResult<V extends GenericRecord<StorageKey>> =\n | IStoreValuesSuccessResult<V>\n | IStoreValuesErrorResult<V>;\n\nexport interface IGetValueSuccessResult<V> {\n key: StorageKey;\n data: V | null | undefined;\n error?: undefined;\n}\n\nexport interface IGetValueErrorResult {\n key: StorageKey;\n data?: never;\n error: Error;\n}\n\nexport type GetValueResult<V> = IGetValueSuccessResult<V> | IGetValueErrorResult;\n\nexport interface IGetValuesSuccessResult<V extends GenericRecord<StorageKey>> {\n keys: (keyof V)[];\n data: V;\n error?: undefined;\n}\n\nexport interface IGetValuesErrorResult<V> {\n keys: (keyof V)[];\n data?: never;\n error: Error;\n}\n\nexport type GetValuesResult<V extends GenericRecord<StorageKey>> =\n | IGetValuesSuccessResult<V>\n | IGetValuesErrorResult<V>;\n\nexport interface IListValuesSuccessResult<V extends GenericRecord<StorageKey>> {\n keys: (keyof V)[];\n data: V;\n error?: undefined;\n}\n\nexport interface IListValuesErrorResult {\n data?: never;\n error: Error;\n}\n\nexport type ListValuesResult<V extends GenericRecord<StorageKey>> =\n | IListValuesSuccessResult<V>\n | IListValuesErrorResult;\n\nexport type IListValuesParams =\n | {\n beginsWith: string;\n }\n | {\n eq: string;\n }\n | {\n gt: string;\n }\n | {\n gte: string;\n }\n | {\n lt: string;\n }\n | {\n lte: string;\n };\n\nexport type RemoveValueResult<V> = StoreValueResult<V>;\n\nexport interface RemoveValuesResult<V extends GenericRecord<StorageKey>> {\n keys: (keyof V)[];\n error?: Error;\n}\n\nexport interface IStore {\n storeValue<V>(key: StorageKey, value: V): Promise<StoreValueResult<V>>;\n storeValues<V extends GenericRecord<StorageKey>>(values: V): Promise<StoreValuesResult<V>>;\n getValue<V>(key: StorageKey): Promise<GetValueResult<V>>;\n getValues<V extends GenericRecord<StorageKey>>(keys: (keyof V)[]): Promise<GetValuesResult<V>>;\n listValues<V extends GenericRecord<StorageKey>>(\n params?: IListValuesParams\n ): Promise<ListValuesResult<V>>;\n removeValue<V>(key: StorageKey): Promise<RemoveValueResult<V>>;\n removeValues<V extends GenericRecord<StorageKey>>(\n keys: (keyof V)[]\n ): Promise<RemoveValuesResult<V>>;\n}\n"],"mappings":"","ignoreList":[]}
package/types.d.ts ADDED
@@ -0,0 +1,24 @@
1
+ import type { NonEmptyArray } from "@webiny/api/types.js";
2
+ export interface IRegistryRegisterParams<T = unknown> {
3
+ item: T;
4
+ app: string;
5
+ tags: NonEmptyArray<string>;
6
+ }
7
+ export interface IRegistryItem<T = unknown> {
8
+ item: T;
9
+ app: string;
10
+ tags: NonEmptyArray<string>;
11
+ }
12
+ export interface IRegistry {
13
+ register<T = unknown>(params: IRegistryRegisterParams<T>): void;
14
+ /**
15
+ * Throws an error if more than one item is found or there is no item found.
16
+ */
17
+ getOneItem<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T>;
18
+ /**
19
+ * Throws an error if more than one item is found.
20
+ */
21
+ getItem<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T> | null;
22
+ getItems<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T>[];
23
+ }
24
+ export * from "./store/types.js";
package/types.js ADDED
@@ -0,0 +1,4 @@
1
+ export * from "./store/types.js";
2
+ export {};
3
+
4
+ //# sourceMappingURL=types.js.map
package/types.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"names":[],"sources":["types.ts"],"sourcesContent":["import type { NonEmptyArray } from \"@webiny/api/types.js\";\n\nexport interface IRegistryRegisterParams<T = unknown> {\n item: T;\n app: string;\n tags: NonEmptyArray<string>;\n}\n\nexport interface IRegistryItem<T = unknown> {\n item: T;\n app: string;\n tags: NonEmptyArray<string>;\n}\n\nexport interface IRegistry {\n register<T = unknown>(params: IRegistryRegisterParams<T>): void;\n /**\n * Throws an error if more than one item is found or there is no item found.\n */\n getOneItem<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T>;\n /**\n * Throws an error if more than one item is found.\n */\n getItem<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T> | null;\n getItems<T = unknown>(cb: (item: IRegistryItem<T>) => boolean): IRegistryItem<T>[];\n}\n\nexport * from \"./store/types.js\";\n"],"mappings":"AA2BA;AAAiC","ignoreList":[]}