datastore-api 6.0.2 → 6.2.0

package/package.json

@@ -1,71 +1,5 @@
 {
-  "name": "datastore-api",
-  "version": "6.0.2",
-  "description": "Simplified, more consitent API for Google Cloud Datastore",
-  "keywords": [
-    "datastore",
-    "google cloud"
-  ],
-  "homepage": "http://github.com/mdornseif/datastore-api/",
-  "repository": "https://github.com/mdornseif/datastore-api",
-  "license": "MIT",
   "author": "Maximillian Dornseif",
-  "main": "dist/index.js",
-  "module": "dist/datastore-api2.esm.js",
-  "typings": "dist/index.d.ts",
-  "files": [
-    "dist",
-    "src"
-  ],
-  "scripts": {
-    "analyze": "size-limit --why",
-    "build": "dts build",
-    "doc": "typedoc src/ --exclude **/*.spec.ts --out build/docs",
-    "lint": "dts lint",
-    "size": "size-limit",
-    "start": "dts watch",
-    "test": "vitest",
-    "unimported": "npx unimported; npx findead src"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*{css,scss,md,markdown,json,yaml,yml,graphql,html}": "npx prettier -w",
-    "*{js,jsx,ts,tsx}": [
-      "npx prettier -w",
-      "npm run lint --fix"
-    ],
-    "package.json": "sort-package-json"
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
-  "prettier": {
-    "printWidth": 110,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "es5"
-  },
-  "release": {
-    "branches": [
-      "main",
-      "master",
-      "next"
-    ],
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/changelog",
-      "@semantic-release/git",
-      "@semantic-release/github",
-      "@semantic-release/npm"
-    ]
-  },
   "ava": {
     "failFast": true,
     "files": [
@@ -78,70 +12,134 @@
       }
     }
   },
-  "nyc": {
-    "exclude": [
-      "**/*.spec.js"
-    ],
-    "extends": "@istanbuljs/nyc-config-typescript"
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
   },
   "dependencies": {
     "@google-cloud/datastore": ">=7.0.0",
     "assertate-debug": "^2.4.2",
     "prom-client": ">=14.0.0"
   },
+  "description": "Simplified, more consistent API for Google Cloud Datastore",
   "devDependencies": {
-    "@google-cloud/promisify": "^3.0.1",
-    "@istanbuljs/nyc-config-typescript": "^1.0.1",
+    "@google-cloud/promisify": ">=4.0.0",
+    "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^11.1.0",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^9.2.6",
-    "@semantic-release/npm": "^11.0.2",
+    "@semantic-release/npm": "^11.0.3",
     "@semantic-release/release-notes-generator": "^12.1.0",
-    "@size-limit/preset-small-lib": "^8.2.6",
-    "@tsconfig/recommended": "^1.0.2",
-    "@types/debug": "^4.1.8",
-    "@types/is": "^0.0.22",
-    "@types/node": "^20.3.3",
-    "@typescript-eslint/eslint-plugin": "^6.18.1",
-    "@typescript-eslint/parser": "^6.18.1",
-    "codecov": "^3.5.0",
+    "@tsconfig/recommended": "^1.0.3",
+    "@types/debug": "^4.1.12",
+    "@types/is": "^0.0.25",
+    "@types/node": "^20.11.24",
+    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/parser": "^7.1.0",
+    "codecov": "^3.8.3",
     "cspell": "5.14.0",
     "cz-conventional-changelog": "^3.3.0",
-    "debug": "^4.3.3",
-    "dts-cli": "^2.0.4",
-    "eslint": "^8.56.0",
+    "debug": "^4.3.4",
+    "dts-cli": "^2.0.5",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-flowtype": "^8.0.3",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react": "^7.34.0",
     "eslint-plugin-react-hooks": "^4.6.0",
     "gh-pages": "^5.0.0",
     "google-datastore-emulator": ">=7.0.0",
-    "husky": "^8.0.3",
-    "lint-staged": "^13.2.3",
+    "husky": "^9.0.11",
+    "lint-staged": "^15.2.2",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
-    "open-cli": "7.2.0",
-    "prettier": "^3.2.2",
+    "open-cli": "8.0.0",
+    "prettier": "^3.2.5",
     "semantic-release": "^23.0.0",
-    "size-limit": "^8.2.6",
-    "sort-package-json": "^2.5.0",
-    "standard-version": "^9.0.0",
-    "ts-essentials": "9.3.2",
-    "ts-node": "^10.4.0",
-    "tslib": "^2.6.0",
-    "typedoc": "0.24.8",
-    "typescript": "<5.1.0",
-    "vitest": "^0.32.2"
+    "sort-package-json": "^2.8.0",
+    "standard-version": "^9.5.0",
+    "ts-essentials": "9.4.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typedoc": "0.25.10",
+    "typescript": "^5.3.3",
+    "vitest": "^1.3.1"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "homepage": "http://github.com/mdornseif/datastore-api/",
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "keywords": [
+    "datastore",
+    "google cloud"
+  ],
+  "license": "MIT",
+  "lint-staged": {
+    "*{css,scss,md,markdown,json,yaml,yml,graphql,html}": "npx prettier -w",
+    "*{js,jsx,ts,tsx}": [
+      "npx prettier -w",
+      "npm run lint --fix"
+    ],
+    "package.json": "sort-package-json"
+  },
+  "main": "dist/index.js",
+  "module": "dist/datastore-api2.esm.js",
+  "name": "datastore-api",
+  "nyc": {
+    "exclude": [
+      "**/*.spec.js"
+    ],
+    "extends": "@istanbuljs/nyc-config-typescript"
   },
   "peerDependencies": {
     "debug": ">=4.0.0"
   },
-  "engines": {
-    "node": ">=16"
-  }
+  "prettier": {
+    "printWidth": 110,
+    "semi": false,
+    "singleQuote": true,
+    "trailingComma": "es5"
+  },
+  "release": {
+    "branches": [
+      "main",
+      "master",
+      "next"
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/git",
+      "@semantic-release/github"
+    ]
+  },
+  "repository": "https://github.com/mdornseif/datastore-api",
+  "scripts": {
+    "build": "dts build",
+    "doc": "typedoc src/ --exclude **/*.spec.ts --out build/docs",
+    "lint": "dts lint",
+    "size": "npx vite-bundle-visualizer -t sunburst # npx source-map-explorer dist/index.js",
+    "start": "dts watch",
+    "test": "vitest",
+    "unimported": "npx findead src ; npx unimported; npx depcheck",
+    "update": "npx npm-check-updates --interactive"
+  },
+  "typings": "dist/index.d.ts",
+  "version": "6.2.0"
 }

package/src/index.ts

@@ -1 +1,2 @@
-export * from './lib/dstore-api';
+export * from './lib/dstore-api'
+export * from './lib/assert'

package/src/lib/assert.ts

@@ -0,0 +1,52 @@
+/*
+ * assert.ts
+ * 
+ * Created by Dr. Maximillian Dornseif 2025-04-11 in datastore-api 6.0.1
+ */
+
+import { Datastore, Key } from './dstore-api'
+import { AssertionMessageType, assert, getType } from 'assertate-debug'
+
+/**
+ * Generates an type assertion message for the given `value`
+ *
+ * @param value value being type-checked
+ * @param type the expected value as a string; eg 'string', 'boolean', 'number'
+ * @param variableName the name of the variable being type-checked
+ * @param additionalMessage further information on failure
+ */
+let AssertionMessage: AssertionMessageType = (
+    value,
+    type,
+    variableName?,
+    additionalMessage?
+): string => {
+    let message = variableName
+        ? `${variableName} must be of type '${type}', '${getType(value)}' provided`
+        : `expected value of type '${type}', '${getType(value)}' provided`
+    return additionalMessage ? `${message}: ${additionalMessage}` : message
+}
+
+/**
+ * Type-checks the provided `value` to be a symbol, throws an Error if it is not
+ *
+ * @param value the value to type-check as a symbol
+ * @param variableName the name of the variable to be type-checked
+ * @param additionalMessage further information on failure
+ * @throws {Error}
+ */
+export function assertIsKey(
+    value: unknown,
+    variableName?: string,
+    additionalMessage?: string
+): asserts value is Key {
+    assert(
+        Datastore.isKey(value as any),
+        AssertionMessage(value, "Key", variableName, additionalMessage)
+    )
+}
+
+
+
+
+