gs-idb-pro 0.1.3 → 0.1.5

package/lib/index.cjs

@@ -607,17 +607,22 @@ class DataWriter extends DataReader {
     return this.batchWrite((w) => returns ? gsBase.asyncMap(records, (v) => w.addOrChange(v)) : gsBase.asyncForEach(records, (v) => w.addOrChange(v)), !0);
   }
   delete(pk, returns) {
+    const {
+      returns: getOld,
+      physical
+    } = gsBase.isBoolean(returns) ? { returns } : returns || {}, { storeSchema } = this, softDeletedField = storeSchema.softDeletedField, requiredOld = !!(!physical && softDeletedField?.name);
     return this.changeByPk({
       pk,
-      getOld: returns,
+      getOld: requiredOld || getOld,
       fn: (store, pk2, newValue, oldValue) => {
-        if (store.delete(pk2), !!returns)
+        if (requiredOld ? oldValue && (oldValue = checkUpdateValue(storeSchema, { [softDeletedField.name]: gsIdbBasic.Bool.True }, oldValue), store.put(oldValue)) : store.delete(pk2), !!getOld)
           return [oldValue, pk2];
       }
     });
   }
   deleteMany(keys, returns) {
-    return this.batchWrite((w) => returns ? gsBase.asyncMap(keys, (v) => w.delete(v, !0)) : gsBase.asyncForEach(keys, (v) => w.delete(v)), !0);
+    const { returns: hasRtn } = gsBase.isBoolean(returns) ? { returns } : returns || {};
+    return this.batchWrite((w) => hasRtn ? gsBase.asyncMap(keys, (v) => w.delete(v, !0)) : gsBase.asyncForEach(keys, (v) => w.delete(v)), !0);
   }
   deleteRange(query, returns) {
     const {
@@ -1041,6 +1046,16 @@ async function upgradeDb(dbSchema, database, e, request) {
   }
 }
 function validateDataOperationSchema(schema, dbSchema) {
+  return Object.isFrozen(dbSchema) ? frozenValidate(schema) : initValidate(schema, dbSchema);
+}
+function frozenValidate(schema, dbSchema) {
+  let { store, index } = schema;
+  const target = { store: gsBase.isString(store) ? store : store.name };
+  return index && (target.index = gsBase.isString(index) ? index : index.name), {
+    target
+  };
+}
+function initValidate(schema, dbSchema) {
   let { store, index } = schema;
   const { storeTemplate } = dbSchema, { storeSchemas = [] } = dbSchema, storeName = gsBase.isString(store) ? store : store.name, storeIndex = storeSchemas.findIndex((s) => s === storeName || s.name === storeName), existStore = storeIndex > -1 && storeSchemas[storeIndex];
   let tmp;
@@ -1253,5 +1268,8 @@ function generateRoot(db, specialFields) {
     }
   });
 }
-var generateDbSchema$1 = /* @__PURE__ */ Object.freeze({ __proto__: null, generateDbSchema });
+var generateDbSchema$1 = /* @__PURE__ */ Object.freeze({
+  __proto__: null,
+  generateDbSchema
+});
 exports.Break = Break, exports.Continue = Continue, exports.ContinueKey = ContinueKey, exports.ContinuePrimaryKey = ContinuePrimaryKey, exports.DataOperationBase = DataOperationBase, exports.DataOperators = DataOperators, exports.DataReader = DataReader, exports.DataWriter = DataWriter, exports.DbIterator = DbIterator, exports.DbIteratorParsers = DbIteratorParsers, exports.DbMap = DbMap, exports.Delete = Delete, exports.Finished = Finished, exports.IDbPro = IDbPro, exports.NextKey = NextKey, exports.NextPrimaryKey = NextPrimaryKey, exports.Save = Save, exports.StoreUpgradeable = StoreUpgradeable, exports.UpgradeContext = UpgradeContext, exports.dbMap = dbMap, exports.dbStore = dbStore, exports.dbStores = dbStores, exports.defaultSpecialFields = defaultSpecialFields, exports.defaultStoreSchemaTemplate = defaultStoreSchemaTemplate, exports.generateDbSchema = generateDbSchema, exports.isIDbQuery = isIDbQuery, exports.isNativeTarget = isNativeTarget, exports.parseDbNoneKeyPathRecord = parseDbNoneKeyPathRecord, exports.parseIDbQuery = parseIDbQuery, exports.releaseDefaultDB = releaseDefaultDB, exports.validateSchemaWithDefaults = validateSchemaWithDefaults, exports.versionDiffValidate = versionDiffValidate, exports.versionSameValidate = versionSameValidate;

package/lib/index.d.ts

@@ -365,7 +365,7 @@ interface IDbMap<K extends StrOrNum = StrOrNum, V = any, Tar extends OperationTa
     batch<R = any, T extends V = V>(fn: (map: IDbMap<K, T, NativeTarget>) => R | Promise<R>): Promise<R>;
 }
 
-interface IGetAllArgs<T> {
+interface IGetAllArgs {
     query?: IDbQuery | null;
     direction?: IDBCursorDirection;
     /**
@@ -381,7 +381,7 @@ interface IDataReader<Row = any, Tar extends OperationTarget = OperationTarget>
      * @param limit 最多返回条数,默认值为1000
      */
     all(query?: IDbQuery, limit?: number): Promise<Row[]>;
-    all(args?: IGetAllArgs<Row>): Promise<Row[]>;
+    all(args?: IGetAllArgs): Promise<Row[]>;
     /**
      * 返回满足条件的第一条数据
      * @param key
@@ -483,15 +483,21 @@ interface IChangeRangeArg<Row> {
      */
     direction?: IDBCursorDirection;
 }
+interface IDeleteRangeOption<Rtn extends boolean | undefined> extends IDeleteOption<Rtn> {
+    /**
+     * 游标滚动方向，默认为`prev`
+     */
+    direction?: IDBCursorDirection;
+}
 interface IRangeWriter<Row> {
     deleteRange(key: IDbQuery, returns?: false): Promise<void>;
     deleteRange(key: IDbQuery, returns: true): Promise<DbRecordResult<Row>[]>;
-    deleteRange(key: IDbQuery, option: IDeleteOption<false | undefined>): Promise<void>;
-    deleteRange(key: IDbQuery, option: IDeleteOption<true>): Promise<DbRecordResult<Row>[]>;
+    deleteRange(key: IDbQuery, option: IDeleteRangeOption<false | undefined>): Promise<void>;
+    deleteRange(key: IDbQuery, option: IDeleteRangeOption<true>): Promise<DbRecordResult<Row>[]>;
     deleteRangeMany(keys: IDbQuery[], returns?: false): Promise<void>;
     deleteRangeMany(keys: IDbQuery[], returns: true): Promise<DbRecordResult<Row>[][]>;
-    deleteRangeMany(keys: IDbQuery[], option: IDeleteOption<false | undefined>): Promise<void>;
-    deleteRangeMany(keys: IDbQuery[], option: IDeleteOption<true>): Promise<DbRecordResult<Row>[][]>;
+    deleteRangeMany(keys: IDbQuery[], option: IDeleteRangeOption<false | undefined>): Promise<void>;
+    deleteRangeMany(keys: IDbQuery[], option: IDeleteRangeOption<true>): Promise<DbRecordResult<Row>[][]>;
     changeRange(arg: DbRecord<Partial<Row>> | IChangeRangeArg<Row>, returns?: false): Promise<void>;
     changeRange(arg: DbRecord<Partial<Row>> | IChangeRangeArg<Row>, returns: true): Promise<DbRecordResult<Row>[]>;
     changeRangeMany(args: DbRecord<Partial<Row>> | IChangeRangeArg<Row>[], returns?: false): Promise<void>;
@@ -503,10 +509,6 @@ interface IChangeManyOption<Rtn extends boolean | undefined> {
     returns?: Rtn;
 }
 interface IDeleteOption<Rtn extends boolean | undefined> {
-    /**
-     * 游标滚动方向，默认为`prev`
-     */
-    direction?: IDBCursorDirection;
     /**
      * 在设置了`softDeletedField`时，是否进行物理删除
      * - 如果值为`false`则仅使用`softDeletedField.name`进行标记
@@ -570,8 +572,12 @@ interface IDataWriter<Row = any, Tar extends OperationTarget = OperationTarget>
      */
     delete(key: IDbQuery, returns?: false): Promise<void>;
     delete(key: IDbQuery, returns: true): Promise<DbRecordResult<Row>>;
+    delete(key: IDbQuery, option: IDeleteOption<false | undefined>): Promise<void>;
+    delete(key: IDbQuery, option: IDeleteOption<true>): Promise<DbRecordResult<Row>>;
     deleteMany(keys: IDbQuery[], returns?: false): Promise<void>;
     deleteMany(keys: IDbQuery[], returns: true): Promise<DbRecordResult<Row>[]>;
+    deleteMany(key: IDbQuery, option: IDeleteOption<false | undefined>): Promise<void>;
+    deleteMany(key: IDbQuery, option: IDeleteOption<true>): Promise<DbRecordResult<Row>[]>;
     /**
      * 批量写入
      * @param fn
@@ -901,7 +907,7 @@ declare class DataOperators<S1 = any, S2 = any, S3 = any, S4 = any, S5 = any> im
 
 declare class DataReader<Row, Tar extends OperationTarget = OperationTarget> extends DataOperationBase implements IDataReader<Row, Tar> {
     all(query?: IDbQuery, limit?: number): Promise<Row[]>;
-    all(args?: IGetAllArgs<Row>): Promise<Row[]>;
+    all(args?: IGetAllArgs): Promise<Row[]>;
     count(): Promise<number>;
     count(query: IDbQuery | FindFn<Row>, direction?: IDBCursorDirection): Promise<number>;
     count(query: IDbQuery, fn: FindFn<Row>, direction?: IDBCursorDirection): Promise<number>;
@@ -956,16 +962,20 @@ declare class DataWriter<Row, Tar extends OperationTarget = OperationTarget> ext
     addOrChangeMany(records: DbRecord<Partial<Row>>[], returns: true): Promise<DbRecordResult<Row>[]>;
     delete(key: IDbQuery, returns?: false): Promise<void>;
     delete(key: IDbQuery, returns: true): Promise<DbRecordResult<Row>>;
+    delete(key: IDbQuery, option: IDeleteOption<false | undefined>): Promise<void>;
+    delete(key: IDbQuery, option: IDeleteOption<true>): Promise<DbRecordResult<Row>>;
     deleteMany(keys: IDbQuery[], returns?: false): Promise<void>;
     deleteMany(keys: IDbQuery[], returns: true): Promise<DbRecordResult<Row>[]>;
+    deleteMany(key: IDbQuery, option: IDeleteOption<false | undefined>): Promise<void>;
+    deleteMany(key: IDbQuery, option: IDeleteOption<true>): Promise<DbRecordResult<Row>[]>;
     deleteRange(key: IDbQuery, returns?: false): Promise<void>;
     deleteRange(key: IDbQuery, returns: true): Promise<DbRecordResult<Row>[]>;
-    deleteRange(key: IDbQuery, option: IDeleteOption<false | undefined>): Promise<void>;
-    deleteRange(key: IDbQuery, option: IDeleteOption<true>): Promise<DbRecordResult<Row>[]>;
+    deleteRange(key: IDbQuery, option: IDeleteRangeOption<false | undefined>): Promise<void>;
+    deleteRange(key: IDbQuery, option: IDeleteRangeOption<true>): Promise<DbRecordResult<Row>[]>;
     deleteRangeMany(keys: IDbQuery[], returns?: false): Promise<void>;
     deleteRangeMany(keys: IDbQuery[], returns: true): Promise<DbRecordResult<Row>[][]>;
-    deleteRangeMany(keys: IDbQuery[], option: IDeleteOption<false | undefined>): Promise<void>;
-    deleteRangeMany(keys: IDbQuery[], option: IDeleteOption<true>): Promise<DbRecordResult<Row>[][]>;
+    deleteRangeMany(keys: IDbQuery[], option: IDeleteRangeOption<false | undefined>): Promise<void>;
+    deleteRangeMany(keys: IDbQuery[], option: IDeleteRangeOption<true>): Promise<DbRecordResult<Row>[][]>;
     changeRange(arg: DbRecord<Partial<Row>> | IChangeRangeArg<Row>, returns?: false): Promise<void>;
     changeRange(arg: DbRecord<Partial<Row>> | IChangeRangeArg<Row>, returns: true): Promise<DbRecordResult<Row>[]>;
     changeRangeMany(args: DbRecord<Partial<Row>> | IChangeRangeArg<Row>[], returns?: false): Promise<void>;
@@ -1116,4 +1126,4 @@ declare function generateDbSchema(db: string, option?: IGenerateOption<undefined
 declare function generateDbSchema(db: string, option: IGenerateOption<true | number>): Promise<string>;
 
 export { Break, Continue, ContinueKey, ContinuePrimaryKey, DataOperationBase, DataOperators, DataReader, DataWriter, DbIterator, DbIteratorParsers, DbMap, Delete, Finished, IDbPro, NextKey, NextPrimaryKey, Save, StoreUpgradeable, UpgradeContext, dbMap, dbStore, dbStores, defaultSpecialFields, defaultStoreSchemaTemplate, generateDbSchema, isIDbQuery, isNativeTarget, parseDbNoneKeyPathRecord, parseIDbQuery, releaseDefaultDB, validateSchemaWithDefaults, versionDiffValidate, versionSameValidate };
-export type { ArrayDbRecord, DBSchema, DataOperationSchema, DbIteratorParsersKey, DbNoneKeyPathRecord, DbRecord, DbRecordResult, ExportDataTo, FindFn, GetRowMapper, IChangeManyOption, IChangeRangeArg, ICursorArg, ICursorOption, ICursorQueryable, ICursorReader, ICursorResultArg, ICursorRow, ICursorWriter, IDataOperationSchema, IDataOperatorFactory, IDataOperators, IDataReader, IDataWriter, IDbGtRange, IDbGteRange, IDbIterator, IDbIteratorArg, IDbIteratorOption, IDbIteratorParser, IDbLtGtRange, IDbLtGteRange, IDbLtRange, IDbLteGtRange, IDbLteGteRange, IDbLteRange, IDbMap, IDbNoneKeyPathRecord, IDbQuery, IDbRange, IDbSchema, IDbVersionBounds, IDeleteOption, IFilterArg, IFindArg, IFindMapArg, IForEachArg, IForEachResultArg, IForEachable, IGenerateOption, IGetAllArgs, IIDbPro, IIndexSchema, IInfoTarget, IModifyResult, IMultiBackup, INativeOperationResult, IOpenCursorArg, IPage, IPageArg, IPageInfo, IPageableQuery, IRangeWriter, ISpecialFieldSchema, ISpecialFields, IStoreSchema, IStoreSchemaTemplate, IStoreUpgradeable, IUpgradeContext, IUpgradeContextArgs, IValidDataOperationSchema, IValueResult, IVersionData, IVersionValidateContext, IVoidResult, ImportUse, IndexSchema, NativeReader, NativeTarget, NativeWriter, OperationTarget, ReadCallFn, RequiredDbNoneKeyPathRecord, SaveRowMapper, SpecialFieldSchema, StoreSchema, ValueCallFn, ValueControl, ValueModifyFn, VersionValidateFn, VoidCallFn, VoidControl, VoidModifyFn, VoidResult, WriteCallFn };
+export type { ArrayDbRecord, DBSchema, DataOperationSchema, DbIteratorParsersKey, DbNoneKeyPathRecord, DbRecord, DbRecordResult, ExportDataTo, FindFn, GetRowMapper, IChangeManyOption, IChangeRangeArg, ICursorArg, ICursorOption, ICursorQueryable, ICursorReader, ICursorResultArg, ICursorRow, ICursorWriter, IDataOperationSchema, IDataOperatorFactory, IDataOperators, IDataReader, IDataWriter, IDbGtRange, IDbGteRange, IDbIterator, IDbIteratorArg, IDbIteratorOption, IDbIteratorParser, IDbLtGtRange, IDbLtGteRange, IDbLtRange, IDbLteGtRange, IDbLteGteRange, IDbLteRange, IDbMap, IDbNoneKeyPathRecord, IDbQuery, IDbRange, IDbSchema, IDbVersionBounds, IDeleteOption, IDeleteRangeOption, IFilterArg, IFindArg, IFindMapArg, IForEachArg, IForEachResultArg, IForEachable, IGenerateOption, IGetAllArgs, IIDbPro, IIndexSchema, IInfoTarget, IModifyResult, IMultiBackup, INativeOperationResult, IOpenCursorArg, IPage, IPageArg, IPageInfo, IPageableQuery, IRangeWriter, ISpecialFieldSchema, ISpecialFields, IStoreSchema, IStoreSchemaTemplate, IStoreUpgradeable, IUpgradeContext, IUpgradeContextArgs, IValidDataOperationSchema, IValueResult, IVersionData, IVersionValidateContext, IVoidResult, ImportUse, IndexSchema, NativeReader, NativeTarget, NativeWriter, OperationTarget, ReadCallFn, RequiredDbNoneKeyPathRecord, SaveRowMapper, SpecialFieldSchema, StoreSchema, ValueCallFn, ValueControl, ValueModifyFn, VersionValidateFn, VoidCallFn, VoidControl, VoidModifyFn, VoidResult, WriteCallFn };

package/lib/{index.js → index.mjs}

@@ -607,17 +607,22 @@ class DataWriter extends DataReader {
     return this.batchWrite((w) => returns ? asyncMap(records, (v) => w.addOrChange(v)) : asyncForEach(records, (v) => w.addOrChange(v)), !0);
   }
   delete(pk, returns) {
+    const {
+      returns: getOld,
+      physical
+    } = isBoolean(returns) ? { returns } : returns || {}, { storeSchema } = this, softDeletedField = storeSchema.softDeletedField, requiredOld = !!(!physical && softDeletedField?.name);
     return this.changeByPk({
       pk,
-      getOld: returns,
+      getOld: requiredOld || getOld,
       fn: (store, pk2, newValue, oldValue) => {
-        if (store.delete(pk2), !!returns)
+        if (requiredOld ? oldValue && (oldValue = checkUpdateValue(storeSchema, { [softDeletedField.name]: Bool.True }, oldValue), store.put(oldValue)) : store.delete(pk2), !!getOld)
           return [oldValue, pk2];
       }
     });
   }
   deleteMany(keys, returns) {
-    return this.batchWrite((w) => returns ? asyncMap(keys, (v) => w.delete(v, !0)) : asyncForEach(keys, (v) => w.delete(v)), !0);
+    const { returns: hasRtn } = isBoolean(returns) ? { returns } : returns || {};
+    return this.batchWrite((w) => hasRtn ? asyncMap(keys, (v) => w.delete(v, !0)) : asyncForEach(keys, (v) => w.delete(v)), !0);
   }
   deleteRange(query, returns) {
     const {
@@ -1041,6 +1046,16 @@ async function upgradeDb(dbSchema, database, e, request) {
   }
 }
 function validateDataOperationSchema(schema, dbSchema) {
+  return Object.isFrozen(dbSchema) ? frozenValidate(schema) : initValidate(schema, dbSchema);
+}
+function frozenValidate(schema, dbSchema) {
+  let { store, index } = schema;
+  const target = { store: isString(store) ? store : store.name };
+  return index && (target.index = isString(index) ? index : index.name), {
+    target
+  };
+}
+function initValidate(schema, dbSchema) {
   let { store, index } = schema;
   const { storeTemplate } = dbSchema, { storeSchemas = [] } = dbSchema, storeName = isString(store) ? store : store.name, storeIndex = storeSchemas.findIndex((s) => s === storeName || s.name === storeName), existStore = storeIndex > -1 && storeSchemas[storeIndex];
   let tmp;
@@ -1253,7 +1268,10 @@ function generateRoot(db, specialFields) {
     }
   });
 }
-var generateDbSchema$1 = /* @__PURE__ */ Object.freeze({ __proto__: null, generateDbSchema });
+var generateDbSchema$1 = /* @__PURE__ */ Object.freeze({
+  __proto__: null,
+  generateDbSchema
+});
 export {
   Break,
   Continue,

package/package.json

@@ -1,25 +1,23 @@
 {
   "name": "gs-idb-pro",
-  "version": "0.1.3",
-  "type": "module",
-  "main": "lib/index.cjs",
-  "module": "lib/index.js",
-  "exports": {
-    "import": "./lib/index.js",
-    "require": "./lib/index.cjs"
-  },
-  "types": "lib/index.d.ts",
+  "version": "0.1.5",
   "license": "MIT",
+  "author": {
+    "name": "grain-sand"
+  },
   "dependencies": {
     "gs-base": "^0.1.20",
     "gs-idb-basic": "^0.1.7"
   },
-  "keywords": [
-    "indexedDB",
-    "webSQL",
-    "idb",
-    "orm",
-    "数据库",
-    "浏览器数据库"
-  ]
-}
+  "type": "module",
+  "types": "./lib/index.d.ts",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./lib/index.cjs",
+      "import": "./lib/index.mjs",
+      "types": "./lib/index.d.ts"
+    }
+  }
+}