@owlmeans/resource 0.1.0

package/src/types.ts

@@ -0,0 +1,129 @@
+import type { BasicConfig, BasicContext, BasicResource, LazyService } from '@owlmeans/context'
+
+export interface Resource<T extends ResourceRecord> extends BasicResource {
+  /**
+   * @throws {UnknownRecordError}
+   */
+  get: <Type extends T>(id: string, field?: Getter, opts?: LifecycleOptions) => Promise<Type>
+  load: <Type extends T>(id: string, field?: Getter, opts?: LifecycleOptions) => Promise<Type | null>
+  list: <Type extends T>(criteria?: ListOptions | ListCriteria, opts?: ListOptions) => Promise<ListResult<Type>>
+  save: <Type extends T>(record: Partial<Type>, opts?: Getter) => Promise<Type>
+  /**
+   * @throws {RecordExists}
+   */
+  create: <Type extends T>(record: Partial<Type>, opts?: LifecycleOptions) => Promise<Type>
+  /**
+   * @throws {UnknownRecordError}
+   */
+  update: <Type extends T>(record: Partial<Type>, opts?: Getter) => Promise<Type>
+  delete: <Type extends T>(id: string | T, opts?: Getter) => Promise<Type | null>
+  /**
+   * @throws {UnknownRecordError}
+   */
+  pick: <Type extends T>(id: string | T, opts?: Getter) => Promise<Type>
+}
+
+export interface ResourceRecord {
+  id?: string
+}
+
+type MaybeArray<T> = T | T[]
+export interface ListCriteria extends Record<string, MaybeArray<ListCriteria | number | string | undefined>> { }
+
+export interface ListOptions {
+  pager?: ListPager
+  criteria?: ListCriteria
+}
+
+export type ListSort = string | [string, boolean?]
+
+export interface ListPager {
+  sort?: ListSort[]
+  page?: number
+  size?: number
+  total?: number
+}
+
+export interface ListResult<T extends ResourceRecord> {
+  items: T[]
+  pager?: ListPager
+}
+
+type Getter = string | GetterOptions
+
+export interface GetterOptions extends LifecycleOptions {
+  field?: string
+}
+
+export interface LifecycleOptions {
+  ttl?: number | Date | string
+}
+
+export interface ResourceMaker<R extends ResourceRecord, T extends Resource<R> = Resource<R>> {
+  (dbAlias?: string, serviceAlias?: string): T
+}
+
+export interface ResourceDbService<Db, Client> extends LazyService {
+  clients: Record<string, Client>
+  /**
+   * @abstract
+   */
+  db: (alias?: string) => Promise<Db>
+
+  /**
+   * @final
+   */
+  config: (alias?: string) => DbConfig
+
+  /**
+   * @abstract
+   */
+  initialize: (alias?: string) => Promise<void>
+
+  /**
+   * @final
+   */
+  ensureConfigAlias: (alias?: string | DbConfig) => string
+
+  /**
+   * @final
+   */
+  name: (alias?: string | DbConfig) => string
+
+  /**
+   * @final
+   */
+  client: (alias?: string) => Promise<Client>
+}
+
+export interface DbLocker<T extends ResourceRecord> {
+  lock: (alias: string, record: Partial<T>, fields: string[]) => Promise<T>
+  unlock: (alias: string, record: Partial<T>, fields: string[]) => Promise<T>
+}
+
+export interface ResourceLocker<T extends ResourceRecord> {
+  lock: (record: Partial<T>, fields?: string[]) => Promise<T>
+  unlock: (record: Partial<T>, fields?: string[]) => Promise<T>
+}
+
+export interface DbConfig<P extends {} = {}> {
+  service: string
+  alias?: string
+  host: string | string[]
+  port?: number
+  user?: string
+  secret?: string
+  schema?: string
+  resourcePrefix?: string
+  entitySensitive?: boolean
+  serviceSensitive?: boolean
+  encryptionKey?: string
+  meta?: P
+}
+
+export interface Config extends BasicConfig {
+  dbs?: DbConfig[]
+}
+
+export interface Context<C extends Config = Config> extends BasicContext<C> {
+}

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+
+export * from './name.js'

package/src/utils/name.ts

@@ -0,0 +1,27 @@
+import { Layer } from '@owlmeans/context'
+import type {Context, Config, ResourceDbService, DbConfig} from '../types.js'
+
+import { sha256 } from '@noble/hashes/sha256'
+import { hex } from '@scure/base'
+
+export const dbName = <C extends Config, T extends Context<C> = Context<C>>(context: T, service: ResourceDbService<any,any>, config: DbConfig) => {
+  let name = config.schema ?? config.alias ?? service.alias
+
+  if (context.cfg.layerId != null 
+    && [Layer.Entity, Layer.User].includes(context.cfg.layer) 
+    && service.layers?.includes(Layer.Entity)) {
+    name = format(name, context.cfg.layerId)
+  }
+
+  return name
+}
+
+const format = (name: string, suffix: string) => {
+  name = (name + '_' + suffix).replace(/\W/g, '_')
+
+  if (name.length > 64) {
+    name = name.substring(0, 31) + '_' + hex.encode(sha256(name.substring(31)))
+  }
+
+  return name
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": [
+    "../tsconfig.default.json",
+  ],
+  "compilerOptions": {
+    "rootDir": "./src/", /* Specify the root folder within your source files. */
+    "outDir": "./build/", /* Specify an output folder for all emitted files. */
+  },
+  "exclude": [
+    "./dist/**/*",
+    "./build/**/*",
+    "./*.ts"
+  ]
+}

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/consts.ts","./src/errors.ts","./src/helper.ts","./src/index.ts","./src/service.ts","./src/types.ts","./src/utils/index.ts","./src/utils/name.ts"],"version":"5.6.3"}