@nu-art/live-docs-shared 0.400.7

package/api.d.ts

@@ -0,0 +1,10 @@
+import { ApiDefResolver, BodyApi, QueryApi } from '@nu-art/thunderstorm-shared';
+import { DB_Document, LiveDocHistoryReqParams, LiveDocReqParams, Request_UpdateDocument } from './types.js';
+export type ApiStruct_LiveDoc = {
+    v1: {
+        get: QueryApi<DB_Document, LiveDocReqParams>;
+        upsert: BodyApi<DB_Document, Request_UpdateDocument>;
+        history: QueryApi<DB_Document, LiveDocHistoryReqParams>;
+    };
+};
+export declare const ApiDef_LiveDoc: ApiDefResolver<ApiStruct_LiveDoc>;

package/api.js

@@ -0,0 +1,25 @@
+/*
+ * Live-Docs will allow you to add and edit tool-tips from within your app...
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { HttpMethod } from '@nu-art/thunderstorm-shared';
+export const ApiDef_LiveDoc = {
+    v1: {
+        get: { method: HttpMethod.GET, path: 'v1/live-docs/unique' },
+        upsert: { method: HttpMethod.POST, path: 'v1/live-docs/upsert' },
+        history: { method: HttpMethod.GET, path: 'v1/live-docs/change-history' }
+    }
+};

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types.js";
+export * from "./api.js";

package/index.js

@@ -0,0 +1,2 @@
+export * from "./types.js";
+export * from "./api.js";

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@nu-art/live-docs-shared",
+  "version": "0.400.7",
+  "description": "Live docs Shared",
+  "keywords": [
+    "TacB0sS",
+    "express",
+    "infra",
+    "live-docs",
+    "nu-art",
+    "thunderstorm",
+    "typescript"
+  ],
+  "homepage": "https://github.com/nu-art-js/thunderstorm",
+  "bugs": {
+    "url": "https://github.com/nu-art-js/thunderstorm/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:nu-art-js/live-docs.git"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "license": "Apache-2.0",
+  "author": "TacB0sS",
+  "scripts": {
+    "build": "tsc"
+  },
+  "contributors": [
+    {
+      "name": "TacB0sS"
+    },
+    {
+      "name": "Cipher",
+      "url": "https://www.linkedin.com/in/itay-leybovich-470b87229/"
+    }
+  ],
+  "dependencies": {
+    "@nu-art/ts-common": "0.400.7",
+    "@nu-art/firebase-shared": "0.400.7",
+    "@nu-art/thunderstorm-shared": "0.400.7",
+    "firebase": "^11.9.0",
+    "firebase-admin": "13.4.0",
+    "firebase-functions": "6.3.2",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-router-dom": "^6.9.0",
+    "moment": "^2.29.4",
+    "express": "^4.18.2",
+    "request": "^2.88.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.0",
+    "@types/express": "^4.17.17",
+    "@types/history": "^4.7.2",
+    "@types/request": "^2.48.1"
+  },
+  "unitConfig": {
+    "type": "typescript-lib"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js"
+    },
+    "./*": {
+      "types": "./*.d.ts",
+      "import": "./*.js"
+    }
+  }
+}

package/types.d.ts

@@ -0,0 +1,20 @@
+import { Auditable } from "@nu-art/ts-common";
+export type LiveDocReqParams = {
+    key: string;
+};
+export type LiveDocHistoryReqParams = LiveDocReqParams & {
+    change: "undo" | "redo";
+};
+type Document = {
+    document: string;
+};
+export type DB_DocumentHistory = Auditable & {
+    docs: DB_Document[];
+    key: string;
+    index: number;
+};
+export type DB_Document = Auditable & Document & {};
+export type Request_UpdateDocument = Document & {
+    key: string;
+};
+export {};

package/types.js

@@ -0,0 +1,19 @@
+/*
+ * Permissions management system, define access level for each of
+ * your server apis, and restrict users by giving them access levels
+ *
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};