@owlmeans/state 0.1.0

package/src/types.ts

@@ -0,0 +1,49 @@
+import type { ListCriteria, Resource, ResourceRecord } from '@owlmeans/resource'
+
+export interface StateResource<T extends ResourceRecord> extends Resource<T> {
+  /**
+   * @returns unsubscribe function
+   */
+  subscribe: (params: StateSubscriptionOption<T>) => [() => void, StateModel<T>[]]
+  listen: (listener: StateListener<T>) => () => void
+  erase: () => Promise<void>
+}
+
+export interface StateSubscriptionOption<T extends ResourceRecord> {
+  id?: string | string[]
+  _systemId?: string
+  query?: ListCriteria
+  default?: Partial<T>
+  listener: StateListener<T>
+}
+
+export interface StateListener<T extends ResourceRecord> {
+  (record: StateModel<T>[]): void | Promise<void>
+}
+
+export interface StateModel<T extends ResourceRecord> {
+  record: T,
+
+  commit: (force?: boolean) => void
+
+  update: (data?: Partial<T>) => void
+
+  clear: () => void
+}
+
+export interface StateResourceAppend {
+  getStateResource: <T extends ResourceRecord>(alias?: string) => StateResource<T>
+}
+
+export interface UseStoreHelper {
+  <T extends ResourceRecord>(id?: string | UseStoreHelperOptions<T>, opts?: string | boolean | UseStoreHelperOptions<T>): StateModel<T>
+}
+
+export interface UseStoreListHelper {
+  <T extends ResourceRecord>(id?: string | string[] | UseStoreHelperOptions<T>, opts?: string | boolean | UseStoreHelperOptions<T>): StateModel<T>[]
+}
+
+export interface UseStoreHelperOptions<T extends ResourceRecord> extends Omit<StateSubscriptionOption<T>, "listener"> {
+  listen?: boolean
+  resource?: string
+}

package/src/utils/index.ts

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

package/src/utils/model.ts

@@ -0,0 +1,42 @@
+import type { ResourceRecord } from '@owlmeans/resource'
+import { MisshapedRecord } from '@owlmeans/resource'
+import type { StateModel, StateResource } from '../types.js'
+
+export const createStateModel = <T extends ResourceRecord>(
+  record: T, resource: StateResource<T>
+): StateModel<T> => {
+  let before: T = record
+  const model: StateModel<T> = {
+    record: { ...record },
+
+    commit: force => {
+      if (force !== true) {
+        if (!Object.entries(before).reduce(
+          (changed, [key, value]) => changed || model.record[key as keyof T] !== value, false
+        ) && !Object.entries(model.record).reduce(
+          (changed, [key, value]) => changed || before[key as keyof T] !== value, false
+        )) {
+          return
+        }
+      }
+      if (record.id == null) {
+        throw new MisshapedRecord('id')
+      }
+      before = model.record
+      void resource.load(record.id).then(exists => {
+        exists != null && resource.update(model.record)
+      })
+    },
+
+    update: data => {
+      Object.assign(model.record, data)
+      model.commit()
+    },
+
+    clear: () => {
+      void resource.delete(record)
+    }
+  }
+
+  return model
+}

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/index.ts","./src/resource.ts","./src/types.ts","./src/utils/index.ts","./src/utils/model.ts"],"version":"5.6.3"}