gs-idb-pro 0.1.2 → 0.1.3

package/lib/index.cjs

@@ -12,7 +12,7 @@ function parseDbNoneKeyPathRecord(record) {
     const { key, value } = record;
     return { key, value };
   }
-  throw new Error(`not include value in invalid DBRecord\uFF1A${JSON.stringify(record)}`);
+  throw new Error(`not include value in invalid DBRecord：${JSON.stringify(record)}`);
 }
 const Break = Symbol("break"), Finished = Symbol("finished"), Continue = Symbol("continue"), ContinueKey = Symbol("continue key"), NextKey = Symbol("next key"), ContinuePrimaryKey = Symbol("continue primary key"), NextPrimaryKey = Symbol("next primary key");
 function isNativeTarget(target) {
@@ -30,7 +30,7 @@ const defaultStoreSchemaTemplate = Object.freeze({
   updatedTimeField: "updated_at"
 }), toNum = (v) => v instanceof Date ? v.getTime() : v;
 function parseIDbQuery(query) {
-  if (gsIdbBasic.isDbQueryOrNull(query))
+  if (gsIdbBasic.isDbQueryOrNull(query) || !gsBase.isObject(query))
     return query;
   const range = query;
   if ("lt" in range && "gt" in range) {
@@ -53,14 +53,10 @@ function parseIDbQuery(query) {
       throw new Error(`Invalid IDBRange: gte (${range.gte}) cannot be greater than lte (${range.lte})`);
     return IDBKeyRange.bound(range.gte, range.lte, !1, !1);
   }
-  if ("lt" in range)
-    return IDBKeyRange.upperBound(range.lt, !0);
-  if ("lte" in range)
-    return IDBKeyRange.upperBound(range.lte, !1);
-  if ("gt" in range)
-    return IDBKeyRange.lowerBound(range.gt, !0);
-  if ("gte" in range)
-    return IDBKeyRange.lowerBound(range.gte, !1);
+  if ("lt" in range) return IDBKeyRange.upperBound(range.lt, !0);
+  if ("lte" in range) return IDBKeyRange.upperBound(range.lte, !1);
+  if ("gt" in range) return IDBKeyRange.lowerBound(range.gt, !0);
+  if ("gte" in range) return IDBKeyRange.lowerBound(range.gte, !1);
 }
 function isIDbQuery(query) {
   return parseIDbQuery(query) != null;
@@ -83,8 +79,7 @@ class DataOperationBase {
     return this.nativeStore?.name || this.target.store;
   }
   get storeSchema() {
-    if (this.#storeSchema)
-      return this.#storeSchema;
+    if (this.#storeSchema) return this.#storeSchema;
     const storeSchema = this.idbPro.getStoreSchema(this.storeName);
     return Object.isFrozen(storeSchema) && (this.#storeSchema = storeSchema), storeSchema;
   }
@@ -93,10 +88,8 @@ class DataOperationBase {
   }
   get nativeStore() {
     const { target } = this;
-    if (target instanceof IDBObjectStore)
-      return target;
-    if (target instanceof IDBIndex)
-      return target.objectStore;
+    if (target instanceof IDBObjectStore) return target;
+    if (target instanceof IDBIndex) return target.objectStore;
   }
   get keyPath() {
     const { target } = this;
@@ -148,7 +141,13 @@ class DataOperationBase {
       startKey,
       startPrimaryKey,
       fn: async (cursor) => {
-        const { value: ov, primaryKey: op } = cursor, result = await fn(ov, op, i++), { control, key, primaryKey, modify, value } = gsBase.isObject(result) ? result : { control: result };
+        const { value: ov, primaryKey: op } = cursor, result = await fn(ov, op, i++), {
+          control,
+          key,
+          primaryKey,
+          modify,
+          value
+        } = gsBase.isObject(result) ? result : { control: result };
         switch (writable && (modify === Save ? cursor.update(value || ov) : modify === Delete && cursor.delete()), control) {
           case Break:
             return !1;
@@ -164,7 +163,15 @@ class DataOperationBase {
       }
     }, !0);
   }
-  async cursorResult({ query, direction, preSkip, startKey, startPrimaryKey, fn, mapper: mpr }, writable) {
+  async cursorResult({
+    query,
+    direction,
+    preSkip,
+    startKey,
+    startPrimaryKey,
+    fn,
+    mapper: mpr
+  }, writable) {
     const { keyPath, defaultGetMapper } = this.storeSchema, mapper = getMapperFn(mpr || defaultGetMapper, keyPath), results = [];
     let i = 0;
     return await this.openCursor({
@@ -174,7 +181,13 @@ class DataOperationBase {
       startKey,
       startPrimaryKey,
       fn: async (cursor) => {
-        const { value: ov, primaryKey: op } = cursor, { control, value, key, primaryKey, modify } = await fn?.(ov, op, i, results) || {};
+        const { value: ov, primaryKey: op } = cursor, {
+          control,
+          value,
+          key,
+          primaryKey,
+          modify
+        } = await fn?.(ov, op, i, results) || {};
         switch (writable && (modify === Save ? cursor.update(value || ov) : modify === Delete && cursor.delete()), (!control || control === Finished || control === NextKey || control === NextPrimaryKey) && results.push(mapper(value || ov, primaryKey || op, i)), control) {
           case Break:
           case Finished:
@@ -232,8 +245,7 @@ class DataOperators {
         const { storeName } = store, rows = data[storeName];
         rows && (result[storeName] = await store[use](rows, returns));
       }
-      if (returns)
-        return result;
+      if (returns) return result;
     }, !0);
   }
   async tx(method, fn, writable, rollbackOnError) {
@@ -264,8 +276,7 @@ class DbIterator extends DataOperationBase {
   startKey;
   startPrimaryKey;
   constructor(schema, db, option) {
-    if (super(schema, db), !option)
-      return;
+    if (super(schema, db), !option) return;
     const { parser } = option;
     this.direction = option.direction, this.query = option.query, this.writable = !!option.writable, this.endsWithNull = !!option.endsWithNull, this.preSkip = option.preSkip, this.startKey = option.startKey, this.startPrimaryKey = option.startPrimaryKey, parser && (this.parser = gsBase.isFunction(parser) ? parser : DbIteratorParsers[parser]);
   }
@@ -277,8 +288,7 @@ class DbIterator extends DataOperationBase {
       if (parser)
         for (; cursor = await gsIdbBasic.requestDbResult(request); ) {
           const { control, value } = await parser(cursor);
-          if (control || (yield value), control === Break)
-            break;
+          if (control || (yield value), control === Break) break;
           cursor.continue();
         }
       else {
@@ -328,18 +338,15 @@ async function queryFnPage(reader, info, arg) {
 }
 async function queryFnRow({ storeSchema: { defaultGetMapper } }, request, info, keyPath, hasSkip) {
   const { page, size, total, maxEmptyChecks, fn } = info, mapper = getMapperFn(info.mapper || defaultGetMapper, keyPath, !0), rows = [], preSkip = (page - 1) * info.size;
-  if (preSkip >= total)
-    return { info: gsBase.deepFreeze(info), rows: [] };
+  if (preSkip >= total) return { info: gsBase.deepFreeze(info), rows: [] };
   let i = 0;
   return await new Promise(async (resolve, reject) => {
     let ept = 0, skipped = 0;
     const rowFn = async () => {
       const { result: cursor } = request;
-      if (!cursor)
-        return resolve();
+      if (!cursor) return resolve();
       let { value, primaryKey } = cursor;
-      if (await fn(value, primaryKey, i) ? (ept = 0, rows.push(mapper(value, primaryKey, i))) : ept++, rows.length >= size || ept >= maxEmptyChecks)
-        return resolve();
+      if (await fn(value, primaryKey, i) ? (ept = 0, rows.push(mapper(value, primaryKey, i))) : ept++, rows.length >= size || ept >= maxEmptyChecks) return resolve();
       i++, cursor.continue();
     };
     request.onerror = () => reject(request.error), hasSkip ? request.onsuccess = async () => {
@@ -360,8 +367,8 @@ async function queryFnRow({ storeSchema: { defaultGetMapper } }, request, info,
 }
 class DataReader extends DataOperationBase {
   all(query, limit) {
-    const param = {};
-    return gsBase.isNumber(limit) && (param.limit = limit), isIDbQuery(query) ? param.query = query : gsBase.isObject(query) && Object.assign(param, query), this.tx(!1, (store) => gsIdbBasic.requestDbResult(store.getAll(parseIDbQuery(param.query), param.limit || 1e3)));
+    const param = isIDbQuery(query) ? { query } : query || {};
+    return gsBase.isNumber(limit) && (param.count = limit), gsBase.isNumber(param.count) || (param.count = 1e3), param.query = parseIDbQuery(param.query), this.tx(!1, (store) => gsIdbBasic.requestDbResult(store.getAll(param)));
   }
   async count(arg1, arg2, arg3) {
     const args = parseFilterArg(arg1, arg2, arg3), { query, direction, fn } = args;
@@ -490,22 +497,27 @@ function getValidKeyValue(keyPath, value) {
     return value[keyPath];
   const rv = [];
   for (const k of keyPath) {
-    if (!value[k])
-      return;
+    if (!value[k]) return;
     rv.push(value[k]);
   }
   return rv;
 }
 function checkAddValue(storeSchema, value) {
-  if (!value || !(value instanceof Object) || Array.isArray(value))
-    return value;
-  const { addedTimeField, updatedTimeField, updatedCountField, softDeletedField } = storeSchema;
+  if (!value || !(value instanceof Object) || Array.isArray(value)) return value;
+  const {
+    addedTimeField,
+    updatedTimeField,
+    updatedCountField,
+    softDeletedField
+  } = storeSchema;
   return value = { ...value }, addedTimeField?.name && !gsBase.isNumber(value[addedTimeField.name]) && (value[addedTimeField.name] = Date.now()), updatedTimeField?.name && !gsBase.isNumber(value[updatedTimeField.name]) && (value[updatedTimeField.name] = Date.now()), softDeletedField?.name && !gsBase.isNumber(value[softDeletedField.name]) && (value[softDeletedField.name] = 0), updatedCountField?.name && (value[updatedCountField.name] = 0), value;
 }
 function checkUpdateValue(storeSchema, newValue, oldValue) {
-  if (!newValue || !(newValue instanceof Object) || Array.isArray(newValue))
-    return newValue;
-  const { updatedTimeField, updatedCountField } = storeSchema;
+  if (!newValue || !(newValue instanceof Object) || Array.isArray(newValue)) return newValue;
+  const {
+    updatedTimeField,
+    updatedCountField
+  } = storeSchema;
   return newValue = { ...oldValue, ...newValue }, updatedTimeField.name && (newValue[updatedTimeField.name] = Date.now()), updatedCountField.name && (newValue[updatedCountField.name] = (newValue[updatedCountField.name] || 0) + 1), newValue;
 }
 class DataWriter extends DataReader {
@@ -534,11 +546,9 @@ class DataWriter extends DataReader {
       }
       if (w.target instanceof IDBIndex) {
         const { keyPath } = w, keyValue = getValidKeyValue(keyPath, value);
-        if (!keyValue)
-          return w.add(record);
+        if (!keyValue) return w.add(record);
         let oldValue = await w.find(keyValue);
-        if (oldValue)
-          return oldValue;
+        if (oldValue) return oldValue;
       }
       return w.add(record);
     });
@@ -577,7 +587,10 @@ class DataWriter extends DataReader {
     });
   }
   changeMany(records, option) {
-    const { returns, throwIfMissing } = gsBase.isBoolean(option) ? { returns: option } : option || {};
+    const {
+      returns,
+      throwIfMissing
+    } = gsBase.isBoolean(option) ? { returns: option } : option || {};
     return this.batchWrite((w) => returns ? gsBase.asyncMap(records, (v) => w.change(v, throwIfMissing)) : gsBase.asyncForEach(records, (v) => w.change(v, throwIfMissing)), !0);
   }
   addOrChange(record) {
@@ -607,11 +620,15 @@ class DataWriter extends DataReader {
     return this.batchWrite((w) => returns ? gsBase.asyncMap(keys, (v) => w.delete(v, !0)) : gsBase.asyncForEach(keys, (v) => w.delete(v)), !0);
   }
   deleteRange(query, returns) {
-    const { returns: hasRtn, physical, direction } = gsBase.isBoolean(returns) ? { returns } : returns || {}, { name } = this.storeSchema.softDeletedField || {};
+    const {
+      returns: hasRtn,
+      physical,
+      direction
+    } = gsBase.isBoolean(returns) ? { returns } : returns || {}, { name } = this.storeSchema.softDeletedField || {};
     return this.cursor({
       query,
       direction,
-      fn: (value) => physical || !name ? { modify: Delete } : (value[name] = 1, { modify: Save })
+      fn: (value) => physical || !name ? { modify: Delete } : (value[name] = gsIdbBasic.Bool.True, { modify: Save })
     }, hasRtn);
   }
   deleteRangeMany(keys, returns) {
@@ -619,9 +636,13 @@ class DataWriter extends DataReader {
     return this.batchWrite((w) => option?.returns ? gsBase.asyncMap(keys, (v) => w.deleteRange(v, option)) : gsBase.asyncForEach(keys, (v) => w.deleteRange(v, option)), !0);
   }
   changeRange(arg, returns) {
-    let { direction = "next", query, newValue } = "newValue" in arg ? arg : { newValue: arg };
+    let {
+      direction = "next",
+      query,
+      newValue
+    } = "newValue" in arg ? arg : { newValue: arg };
     if (query || (query = getValidKeyValue(this.keyPath, newValue)), !query)
-      throw new Error(`query is required\uFF1A${JSON.stringify(arg)}`);
+      throw new Error(`query is required：${JSON.stringify(arg)}`);
     return this.cursor({
       query,
       direction,
@@ -725,16 +746,12 @@ class DbMap extends DataOperationBase {
   }
 }
 function equalKeyPath(p1, p2) {
-  if (p1 == p2)
-    return !0;
-  if (typeof p1 != typeof p2)
-    return !1;
+  if (p1 == p2) return !0;
+  if (typeof p1 != typeof p2) return !1;
   if (Array.isArray(p1) && Array.isArray(p2)) {
-    if (p1.length !== p2.length)
-      return !1;
+    if (p1.length !== p2.length) return !1;
     for (let i = 0; i < p1.length; i++)
-      if (p1[i] !== p2[i])
-        return !1;
+      if (p1[i] !== p2[i]) return !1;
     return !0;
   }
   return !1;
@@ -755,7 +772,7 @@ const versionDiffValidate = ({ stores, schema }) => {
       }
     }
   }
-  return info ? `The existing database is inconsistent with the definition and cannot be corrected\uFF1A ${info}` : !0;
+  return info ? `The existing database is inconsistent with the definition and cannot be corrected： ${info}` : !0;
 }, versionSameValidate = async (context) => {
   let result = versionDiffValidate(context);
   return gsBase.isString(result) || (result = validateStoreAndIndexes(context)), result;
@@ -765,13 +782,12 @@ const versionDiffValidate = ({ stores, schema }) => {
   const missingStoreNames = storeSchemas.map((s) => s.name).filter((s) => !dbStoreNames.includes(s));
   if (missingStoreNames.length)
     info = `store [ ${missingStoreNames.join(",")} ] not exist`;
-  else
-    for (const store of stores) {
-      const ss = storeSchemas.find((s) => s.name === store.name);
-      if (ss && (info = validateIndexes$1(store, Array.from(store.indexNames), ss.indexSchemas), info))
-        break;
-    }
-  return info ? `The existing database Store index is inconsistent with the definition and requires a database version upgrade to be fixed\uFF1A ${info}` : !0;
+  else for (const store of stores) {
+    const ss = storeSchemas.find((s) => s.name === store.name);
+    if (ss && (info = validateIndexes$1(store, Array.from(store.indexNames), ss.indexSchemas), info))
+      break;
+  }
+  return info ? `The existing database Store index is inconsistent with the definition and requires a database version upgrade to be fixed： ${info}` : !0;
 };
 function validateIndexes$1(store, indexNames, schemas) {
   if (indexNames.length !== schemas.length)
@@ -874,7 +890,7 @@ function validateDefaultData(schema) {
   if (!(schema.keyPath || !schema.defaultData?.length)) {
     for (const row of schema.defaultData)
       if (!Array.isArray(row) && !("value" in row))
-        throw new Error(`When \`defaultData\` must contain \`value\` fields or be an array\uFF1A${JSON.stringify(row)}`);
+        throw new Error(`When \`defaultData\` must contain \`value\` fields or be an array：${JSON.stringify(row)}`);
   }
 }
 const validateSchemaWithDefaults = (schema) => {
@@ -983,12 +999,11 @@ async function upgradeDb(dbSchema, database, e, request) {
   const { storeSchemas, beforeUpgrade, afterUpgrade, version } = dbSchema, { newVersion = version, oldVersion } = e, { transaction } = request, context = new UpgradeContext({ database, newVersion, oldVersion, dbSchema, transaction });
   try {
     const errors = [];
-    if (gsBase.isFunction(beforeUpgrade))
-      try {
-        await beforeUpgrade(context);
-      } catch (e2) {
-        errors.push(e2);
-      }
+    if (gsBase.isFunction(beforeUpgrade)) try {
+      await beforeUpgrade(context);
+    } catch (e2) {
+      errors.push(e2);
+    }
     for (const storeName of storeSchemas.map((s) => s.name))
       try {
         context.store(storeName);
@@ -996,34 +1011,30 @@ async function upgradeDb(dbSchema, database, e, request) {
         errors.push(e2);
       }
     for (const { name, defaultData } of storeSchemas)
-      if (defaultData)
+      if (defaultData) try {
+        await context.store(name).add({ oldMax: 0 }, defaultData);
+      } catch (e2) {
+        errors.push(e2);
+      }
+    for (const { name, versionData } of storeSchemas)
+      if (versionData) for (const { version: version2, data, use = "addOrChange" } of versionData)
         try {
-          await context.store(name).add({ oldMax: 0 }, defaultData);
+          await context.store(name)[use](version2, data);
         } catch (e2) {
           errors.push(e2);
         }
-    for (const { name, versionData } of storeSchemas)
-      if (versionData)
-        for (const { version: version2, data, use = "addOrChange" } of versionData)
-          try {
-            await context.store(name)[use](version2, data);
-          } catch (e2) {
-            errors.push(e2);
-          }
     for (const { name, storeDefined } of storeSchemas)
       try {
         await storeDefined?.(context.store(name));
       } catch (e2) {
         errors.push(e2);
       }
-    if (gsBase.isFunction(afterUpgrade))
-      try {
-        await afterUpgrade(context);
-      } catch (e2) {
-        errors.push(e2);
-      }
-    if (!errors.length)
-      return;
+    if (gsBase.isFunction(afterUpgrade)) try {
+      await afterUpgrade(context);
+    } catch (e2) {
+      errors.push(e2);
+    }
+    if (!errors.length) return;
     throw errors.length === 1 ? errors[0] : new AggregateError(errors, "Database upgrade error");
   } finally {
     gsBase.destroy(context);
@@ -1135,8 +1146,7 @@ class IDbPro {
     return this.factory.newDataOperators(results, this);
   }
   initSchema() {
-    if (this.initialized)
-      return this.#schema;
+    if (this.initialized) return this.#schema;
     const { validateSchemaWithDefaults: validate = validateSchemaWithDefaults } = this.#schema;
     return this.#schema = validate(this.#schema);
   }

package/lib/index.d.ts

@@ -367,10 +367,11 @@ interface IDbMap<K extends StrOrNum = StrOrNum, V = any, Tar extends OperationTa
 
 interface IGetAllArgs<T> {
     query?: IDbQuery | null;
+    direction?: IDBCursorDirection;
     /**
      * 最多返回条数,默认值为1000
      */
-    limit?: number;
+    count?: number;
 }
 interface IDataReader<Row = any, Tar extends OperationTarget = OperationTarget> extends IValidDataOperationSchema<Tar>, ICursorReader<Row>, IForEachable<Row>, ICursorQueryable<Row>, IPageableQuery<Row> {
     readonly storeName: string;