@proteinjs/app-version-common 1.0.1

package/.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended', 'prettier'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint', 'prettier'],
+  root: true,
+  ignorePatterns: ['**/dist/*', '**/node_modules/*', '*.md'],
+
+  rules: {
+    'prettier/prettier': ['warn'],
+    curly: ['warn'],
+    'eol-last': ['warn', 'always'],
+    'keyword-spacing': ['warn', { before: true }],
+    'no-undef': 'off',
+    '@typescript-eslint/no-unused-vars': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/prefer-as-const': 'off',
+    '@typescript-eslint/ban-types': 'off',
+  },
+};

package/.prettierignore

@@ -0,0 +1,4 @@
+node_modules/
+dist/
+.DS_Store
+*.md

package/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": true,
+  "jsxSingleQuote": true,
+  "printWidth": 120
+}

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1 (2024-08-02)
+
+
+### Bug Fixes
+
+* initial implementation of `app-version-common` ([0f17806](https://github.com/proteinjs/notifications/commit/0f17806a7d4315b49e627a73aefab59d0098bfc7))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Brent Bahry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/generated/index.d.ts

@@ -0,0 +1,5 @@
+/** Load Dependency Source Graphs */
+import '@proteinjs/reflection';
+import '@proteinjs/service';
+export * from '../index';
+//# sourceMappingURL=index.d.ts.map

package/dist/generated/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":"AAAA,oCAAoC;AAEpC,OAAO,uBAAuB,CAAC;AAC/B,OAAO,oBAAoB,CAAC;AAqB5B,cAAc,UAAU,CAAC"}

package/dist/generated/index.js

@@ -0,0 +1,28 @@
+"use strict";
+/** Load Dependency Source Graphs */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("@proteinjs/reflection");
+require("@proteinjs/service");
+/** Generate Source Graph */
+const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/app-version-common/LatestVersionRequiringUpdate\",\"value\":{\"packageName\":\"@proteinjs/app-version-common\",\"name\":\"LatestVersionRequiringUpdate\",\"filePath\":\"/home/runner/work/notifications/notifications/packages/app-version/common/src/LatestVersionRequiringUpdate.ts\",\"qualifiedName\":\"@proteinjs/app-version-common/LatestVersionRequiringUpdate\",\"properties\":[{\"name\":\"version\",\"type\":{\"packageName\":\"\",\"name\":\"string\",\"filePath\":null,\"qualifiedName\":\"/string\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\"}],\"methods\":[],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/app-version-common/VersionCheckerService\",\"value\":{\"packageName\":\"@proteinjs/app-version-common\",\"name\":\"VersionCheckerService\",\"filePath\":\"/home/runner/work/notifications/notifications/packages/app-version/common/src/services/VersionCheckerService.ts\",\"qualifiedName\":\"@proteinjs/app-version-common/VersionCheckerService\",\"properties\":[],\"methods\":[{\"name\":\"needToUpdate\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<boolean>\",\"filePath\":null,\"qualifiedName\":\"/Promise<boolean>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"currentVersion\",\"type\":{\"packageName\":\"\",\"name\":\"string\",\"filePath\":null,\"qualifiedName\":\"/string\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/service\",\"name\":\"Service\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/service/Service\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/service/Service\"}],\"edges\":[{\"v\":\"@proteinjs/app-version-common/LatestVersionRequiringUpdate\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/app-version-common/VersionCheckerService\",\"w\":\"@proteinjs/service/Service\",\"value\":\"extends interface\"}]}";
+/** Generate Source Links */
+const sourceLinks = {};
+/** Load Source Graph and Links */
+const reflection_1 = require("@proteinjs/reflection");
+reflection_1.SourceRepository.merge(sourceGraph, sourceLinks);
+__exportStar(require("../index"), exports);
+//# sourceMappingURL=index.js.map

package/dist/generated/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../generated/index.ts"],"names":[],"mappings":";AAAA,oCAAoC;;;;;;;;;;;;;;;;AAEpC,iCAA+B;AAC/B,8BAA4B;AAG5B,4BAA4B;AAE5B,MAAM,WAAW,GAAG,igFAAigF,CAAC;AAGthF,4BAA4B;AAG5B,MAAM,WAAW,GAAG,EACnB,CAAC;AAGF,kCAAkC;AAElC,sDAAyD;AACzD,6BAAgB,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAGjD,2CAAyB"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './src/LatestVersionRequiringUpdate';
+export * from './src/services/VersionCheckerService';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAC;AACnD,cAAc,sCAAsC,CAAC"}

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/LatestVersionRequiringUpdate"), exports);
+__exportStar(require("./src/services/VersionCheckerService"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qEAAmD;AACnD,uEAAqD"}

package/dist/src/LatestVersionRequiringUpdate.d.ts

@@ -0,0 +1,18 @@
+import { Loadable } from '@proteinjs/reflection';
+export declare const getLatestVersionRequiringUpdate: () => LatestVersionRequiringUpdate;
+/**
+ * Implement this interface to provide the latest version of your app that
+ * contains changes the user should get a fresh bundle for.
+ *
+ * Instead of prompting the user to reload their page with every new app version
+ * deployed, use this to specify versions that you feel are worthy of pestering
+ * the user about (ie. breaking changes, significant feature drops, etc.).
+ */
+export interface LatestVersionRequiringUpdate extends Loadable {
+    /**
+     * If the user's bundle version is lower than this version, the `AppVersionUpdateBanner`
+     * will be displayed until they reload the page.
+     */
+    version: string;
+}
+//# sourceMappingURL=LatestVersionRequiringUpdate.d.ts.map

package/dist/src/LatestVersionRequiringUpdate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LatestVersionRequiringUpdate.d.ts","sourceRoot":"","sources":["../../src/LatestVersionRequiringUpdate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,uBAAuB,CAAC;AAEnE,eAAO,MAAM,+BAA+B,oCAGzC,CAAC;AAEJ;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA6B,SAAQ,QAAQ;IAC5D;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/dist/src/LatestVersionRequiringUpdate.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLatestVersionRequiringUpdate = void 0;
+const reflection_1 = require("@proteinjs/reflection");
+const getLatestVersionRequiringUpdate = () => reflection_1.SourceRepository.get().object('@proteinjs/app-version-common/LatestVersionRequiringUpdate');
+exports.getLatestVersionRequiringUpdate = getLatestVersionRequiringUpdate;
+//# sourceMappingURL=LatestVersionRequiringUpdate.js.map

package/dist/src/LatestVersionRequiringUpdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LatestVersionRequiringUpdate.js","sourceRoot":"","sources":["../../src/LatestVersionRequiringUpdate.ts"],"names":[],"mappings":";;;AAAA,sDAAmE;AAE5D,MAAM,+BAA+B,GAAG,GAAG,EAAE,CAClD,6BAAgB,CAAC,GAAG,EAAE,CAAC,MAAM,CAC3B,4DAA4D,CAC7D,CAAC;AAHS,QAAA,+BAA+B,mCAGxC"}

package/dist/src/services/VersionCheckerService.d.ts

@@ -0,0 +1,12 @@
+import { Service } from '@proteinjs/service';
+export declare const getVersionCheckerService: () => VersionCheckerService;
+export interface VersionCheckerService extends Service {
+    /**
+     * Check to see if the current page needs to be updated to the latest
+     * bundle version.
+     * @param currentVersion the current version of the bundle
+     * @return true if the page needs a newer bundle version
+     */
+    needToUpdate(currentVersion: string): Promise<boolean>;
+}
+//# sourceMappingURL=VersionCheckerService.d.ts.map

package/dist/src/services/VersionCheckerService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VersionCheckerService.d.ts","sourceRoot":"","sources":["../../../src/services/VersionCheckerService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAkB,MAAM,oBAAoB,CAAC;AAE7D,eAAO,MAAM,wBAAwB,6BAEpC,CAAC;AAEF,MAAM,WAAW,qBAAsB,SAAQ,OAAO;IACpD;;;;;OAKG;IACH,YAAY,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACxD"}

package/dist/src/services/VersionCheckerService.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVersionCheckerService = void 0;
+const service_1 = require("@proteinjs/service");
+exports.getVersionCheckerService = (0, service_1.serviceFactory)('@proteinjs/app-version-common/VersionCheckerService');
+//# sourceMappingURL=VersionCheckerService.js.map

package/dist/src/services/VersionCheckerService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VersionCheckerService.js","sourceRoot":"","sources":["../../../src/services/VersionCheckerService.ts"],"names":[],"mappings":";;;AAAA,gDAA6D;AAEhD,QAAA,wBAAwB,GAAG,IAAA,wBAAc,EACpD,qDAAqD,CACtD,CAAC"}

package/generated/index.ts

@@ -0,0 +1,25 @@
+/** Load Dependency Source Graphs */
+
+import '@proteinjs/reflection';
+import '@proteinjs/service';
+
+
+/** Generate Source Graph */
+
+const sourceGraph = "{\"options\":{\"directed\":true,\"multigraph\":false,\"compound\":false},\"nodes\":[{\"v\":\"@proteinjs/app-version-common/LatestVersionRequiringUpdate\",\"value\":{\"packageName\":\"@proteinjs/app-version-common\",\"name\":\"LatestVersionRequiringUpdate\",\"filePath\":\"/home/runner/work/notifications/notifications/packages/app-version/common/src/LatestVersionRequiringUpdate.ts\",\"qualifiedName\":\"@proteinjs/app-version-common/LatestVersionRequiringUpdate\",\"properties\":[{\"name\":\"version\",\"type\":{\"packageName\":\"\",\"name\":\"string\",\"filePath\":null,\"qualifiedName\":\"/string\",\"typeParameters\":null,\"directParents\":null},\"isOptional\":false,\"isAbstract\":false,\"isStatic\":false,\"visibility\":\"public\"}],\"methods\":[],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/reflection\",\"name\":\"Loadable\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/reflection/Loadable\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/reflection/Loadable\"},{\"v\":\"@proteinjs/app-version-common/VersionCheckerService\",\"value\":{\"packageName\":\"@proteinjs/app-version-common\",\"name\":\"VersionCheckerService\",\"filePath\":\"/home/runner/work/notifications/notifications/packages/app-version/common/src/services/VersionCheckerService.ts\",\"qualifiedName\":\"@proteinjs/app-version-common/VersionCheckerService\",\"properties\":[],\"methods\":[{\"name\":\"needToUpdate\",\"returnType\":{\"packageName\":\"\",\"name\":\"Promise<boolean>\",\"filePath\":null,\"qualifiedName\":\"/Promise<boolean>\",\"typeParameters\":null,\"directParents\":null},\"isAsync\":false,\"isOptional\":false,\"isAbstract\":true,\"isStatic\":false,\"visibility\":\"public\",\"parameters\":[{\"name\":\"currentVersion\",\"type\":{\"packageName\":\"\",\"name\":\"string\",\"filePath\":null,\"qualifiedName\":\"/string\",\"typeParameters\":null,\"directParents\":null}}]}],\"typeParameters\":[],\"directParents\":[{\"packageName\":\"@proteinjs/service\",\"name\":\"Service\",\"filePath\":null,\"qualifiedName\":\"@proteinjs/service/Service\",\"properties\":[],\"methods\":[],\"typeParameters\":[],\"directParents\":[]}],\"sourceType\":3}},{\"v\":\"@proteinjs/service/Service\"}],\"edges\":[{\"v\":\"@proteinjs/app-version-common/LatestVersionRequiringUpdate\",\"w\":\"@proteinjs/reflection/Loadable\",\"value\":\"extends interface\"},{\"v\":\"@proteinjs/app-version-common/VersionCheckerService\",\"w\":\"@proteinjs/service/Service\",\"value\":\"extends interface\"}]}";
+
+
+/** Generate Source Links */
+
+
+const sourceLinks = {
+};
+
+
+/** Load Source Graph and Links */
+
+import { SourceRepository } from '@proteinjs/reflection';
+SourceRepository.merge(sourceGraph, sourceLinks);
+
+
+export * from '../index';

package/index.ts

@@ -0,0 +1,2 @@
+export * from './src/LatestVersionRequiringUpdate';
+export * from './src/services/VersionCheckerService';

package/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+  roots: ['<rootDir>/test'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  testEnvironment: 'node',
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@proteinjs/app-version-common",
+  "version": "1.0.1",
+  "description": "App version runtime-agnostic components",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/proteinjs/notifications.git"
+  },
+  "bugs": {
+    "url": "https://github.com/proteinjs/notifications/issues"
+  },
+  "homepage": "https://github.com/proteinjs/notifications#readme",
+  "author": "Brent Bahry",
+  "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf dist/ generated/ node_modules/",
+    "build": "reflection-build && tsc",
+    "watch": "reflection-watch"
+  },
+  "dependencies": {
+    "@proteinjs/reflection": "1.1.7",
+    "@proteinjs/service": "1.0.24"
+  },
+  "devDependencies": {
+    "@proteinjs/reflection-build": "1.0.22",
+    "@types/jest": "29.5.5",
+    "@types/node": "20.8.2",
+    "@typescript-eslint/eslint-plugin": "7.8.0",
+    "@typescript-eslint/parser": "7.8.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.3",
+    "jest": "29.7.0",
+    "ts-jest": "29.1.1",
+    "typescript": "5.2.2"
+  },
+  "main": "./dist/generated/index.js",
+  "types": "./dist/generated/index.d.ts",
+  "gitHead": "b3340adf0c32126349cd3f74e1544ab1a0381d5e"
+}

package/src/LatestVersionRequiringUpdate.ts

@@ -0,0 +1,22 @@
+import { Loadable, SourceRepository } from '@proteinjs/reflection';
+
+export const getLatestVersionRequiringUpdate = () =>
+  SourceRepository.get().object<LatestVersionRequiringUpdate>(
+    '@proteinjs/app-version-common/LatestVersionRequiringUpdate'
+  );
+
+/**
+ * Implement this interface to provide the latest version of your app that
+ * contains changes the user should get a fresh bundle for.
+ *
+ * Instead of prompting the user to reload their page with every new app version
+ * deployed, use this to specify versions that you feel are worthy of pestering
+ * the user about (ie. breaking changes, significant feature drops, etc.).
+ */
+export interface LatestVersionRequiringUpdate extends Loadable {
+  /**
+   * If the user's bundle version is lower than this version, the `AppVersionUpdateBanner`
+   * will be displayed until they reload the page.
+   */
+  version: string;
+}

package/src/services/VersionCheckerService.ts

@@ -0,0 +1,15 @@
+import { Service, serviceFactory } from '@proteinjs/service';
+
+export const getVersionCheckerService = serviceFactory<VersionCheckerService>(
+  '@proteinjs/app-version-common/VersionCheckerService'
+);
+
+export interface VersionCheckerService extends Service {
+  /**
+   * Check to see if the current page needs to be updated to the latest
+   * bundle version.
+   * @param currentVersion the current version of the bundle
+   * @return true if the page needs a newer bundle version
+   */
+  needToUpdate(currentVersion: string): Promise<boolean>;
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "rootDir": "./",
+    "target": "es6",
+    "module": "commonjs",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist/",
+    "strict": true,
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "jsx": "react"
+  }
+}