Merge pull request #450 from coasys/hooks-docs

Hooks & docs for langauge and hooks

.github/workflows/publish.yml

@@ -356,6 +356,30 @@ jobs:
           package: connect/package.json
           access: public
 
+      - name: Publish ad4m hook helpers
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.COASYS_NPM_TOKEN }}
+          package: ad4m-hooks/helpers/package.json
+          tag: ${{ env.NPM_TAG }}
+          access: public
+
+      - name: Publish ad4m react hooks
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.COASYS_NPM_TOKEN }}
+          package: ad4m-hooks/react/package.json
+          tag: ${{ env.NPM_TAG }}
+          access: public
+
+      - name: Publish ad4m vue hooks
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.COASYS_NPM_TOKEN }}
+          package: ad4m-hooks/vue/package.json
+          tag: ${{ env.NPM_TAG }}
+          access: public
+
       - name: Publish executor
         uses: JS-DevTools/npm-publish@v1
         with:

.github/workflows/publish_staging.yml

@@ -382,6 +382,30 @@ jobs:
           package: connect/package.json
           tag: ${{ env.NPM_TAG }}
           access: public
+
+      - name: Publish ad4m hook helpers
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.COASYS_NPM_TOKEN }}
+          package: ad4m-hooks/helpers/package.json
+          tag: ${{ env.NPM_TAG }}
+          access: public
+
+      - name: Publish ad4m react hooks
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.COASYS_NPM_TOKEN }}
+          package: ad4m-hooks/react/package.json
+          tag: ${{ env.NPM_TAG }}
+          access: public
+
+      - name: Publish ad4m vue hooks
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.COASYS_NPM_TOKEN }}
+          package: ad4m-hooks/vue/package.json
+          tag: ${{ env.NPM_TAG }}
+          access: public
 
       - name: Publish executor
         uses: JS-DevTools/npm-publish@v1

ad4m-hooks/.gitignore

@@ -0,0 +1,25 @@
+node_modules
+dist
+package-lock.json
+
+**/.vitepress/cache
+
+# Log files
+*.log
+
+# Editor directories and files
+.idea
+.vscode
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+*.turbo
+dev-dist
+.DS_Store
+
+cachedb
+# Local Netlify folder
+.netlify
+!register.js

ad4m-hooks/helpers/package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@coasys/hooks-helpers",
+    "version": "0.8.2-prerelease",
+    "description": "",
+    "main": "./src/index.ts",
+    "module": "./src/index.ts",
+    "private": false,
+    "type": "module",
+    "files": [
+      "dist",
+      "src"
+    ],
+    "scripts": {},
+    "keywords": [],
+    "author": "",
+    "license": "ISC",
+    "dependencies": {
+      "@coasys/ad4m": "*",
+      "@coasys/ad4m-connect": "*",
+      "uuid": "*"
+    }
+  }

ad4m-hooks/helpers/src/cache.ts

@@ -0,0 +1,70 @@
+import { PerspectiveProxy } from "@coasys/ad4m";
+
+const cache: Map<string, any> = new Map();
+const subscribers: Map<string, Function[]> = new Map();
+
+export function getCache<T>(key: string) {
+  const match: T | undefined = cache.get(key);
+  return match;
+}
+
+export function setCache<T>(key: string, value: T) {
+  cache.set(key, value);
+  getSubscribers(key).forEach((cb) => cb());
+}
+
+export function subscribe(key: string, callback: Function) {
+  getSubscribers(key).push(callback);
+}
+
+export function unsubscribe(key: string, callback: Function) {
+  const subs = getSubscribers(key);
+  const index = subs.indexOf(callback);
+  if (index >= 0) {
+    subs.splice(index, 1);
+  }
+}
+
+export function getSubscribers(key: string) {
+  if (!subscribers.has(key)) subscribers.set(key, []);
+  return subscribers.get(key)!;
+}
+
+export function subscribeToPerspective(
+  perspective: PerspectiveProxy,
+  added: Function,
+  removed: Function
+) {
+  const addedKey = `perspective-${perspective.uuid}-added`;
+  const removedKey = `perspective-${perspective.uuid}-removed`;
+
+  if (!subscribers.has(addedKey)) {
+    console.log("subscribing!");
+    perspective.addListener("link-added", (link) => {
+      subscribers.get(addedKey).forEach((cb) => cb(link));
+      return null;
+    });
+  }
+
+  if (!subscribers.has(removedKey)) {
+    perspective.addListener("link-removed", (link) => {
+      subscribers.get(removedKey).forEach((cb) => cb(link));
+      return null;
+    });
+  }
+
+  subscribe(addedKey, added);
+  subscribe(removedKey, removed);
+}
+
+export function unsubscribeFromPerspective(
+  perspective: PerspectiveProxy,
+  added: Function,
+  removed: Function
+) {
+  const addedKey = `perspective-${perspective.uuid}-added`;
+  const removedKey = `perspective-${perspective.uuid}-removed`;
+
+  unsubscribe(addedKey, added);
+  unsubscribe(removedKey, removed);
+}