@schematichq/schematic-js 0.0.10

package/README.md

@@ -0,0 +1,60 @@
+# schematic-js
+
+## Install
+
+```
+yarn install
+```
+
+## Build
+
+```
+yarn build
+```
+
+## Usage example
+
+```javascript
+const schematic = new Schematic("your-api-key");
+
+// Send an identify event
+const userId = "my-user-id";
+const keys = {
+  id: userId,
+};
+const traits = {
+  anykey: "anyval",
+};
+const company = {
+  name: "My Company",
+  keys: {
+    id: "my-company-id",
+  },
+  traits: {
+    location: "Atlanta, GA",
+  },
+};
+schematic.identify({ keys, traits, company });
+
+// Send a track event
+const event = "query";
+const traits = {
+};
+const company = {
+};
+const user = {
+},
+schematic.track({
+  event: "query",
+  traits: {
+      feature: "feat_cns2asuKAG2",
+  },
+  company: {
+    id: "my-company-id",
+  },
+  name: "My User",
+  user: {
+    id: "my-user-id",
+  },
+});
+```

package/dist/schematic.browser.js

@@ -0,0 +1,2 @@
+"use strict";(()=>{var d,g=new Uint8Array(16);function u(){if(!d&&(d=typeof crypto<"u"&&crypto.getRandomValues&&crypto.getRandomValues.bind(crypto),!d))throw new Error("crypto.getRandomValues() not supported. See https://github.com/uuidjs/uuid#getrandomvalues-not-supported");return d(g)}var o=[];for(let t=0;t<256;++t)o.push((t+256).toString(16).slice(1));function h(t,e=0){return(o[t[e+0]]+o[t[e+1]]+o[t[e+2]]+o[t[e+3]]+"-"+o[t[e+4]]+o[t[e+5]]+"-"+o[t[e+6]]+o[t[e+7]]+"-"+o[t[e+8]]+o[t[e+9]]+"-"+o[t[e+10]]+o[t[e+11]]+o[t[e+12]]+o[t[e+13]]+o[t[e+14]]+o[t[e+15]]).toLowerCase()}var l=typeof crypto<"u"&&crypto.randomUUID&&crypto.randomUUID.bind(crypto),y={randomUUID:l};function m(t,e,n){if(y.randomUUID&&!e&&!t)return y.randomUUID();t=t||{};let i=t.random||(t.rng||u)();if(i[6]=i[6]&15|64,i[8]=i[8]&63|128,e){n=n||0;for(let r=0;r<16;++r)e[n+r]=i[r];return e}return h(i)}var a=m;var v="schematicId";var c=class{apiKey;eventQueue;storage;constructor(e,n){this.apiKey=e,this.eventQueue=[],n?this.storage=n:typeof localStorage<"u"&&(this.storage=localStorage)}sendEvent(e){let n="https://c.schematichq.com/e",i=JSON.stringify(e);fetch(n,{method:"POST",headers:{"Content-Type":"application/json;charset=UTF-8"},body:i}).then(r=>{if(!r.ok)throw new Error(`Network response was not ok: ${r.statusText}`)}).catch(r=>{console.error("There was a problem with the fetch operation:",r)})}flushEventQueue(){for(;this.eventQueue.length>0;){let e=this.eventQueue.shift();e&&this.sendEvent(e)}}storeEvent(e){this.eventQueue.push(e)}handleEvent(e,n){let i={api_key:this.apiKey,body:n,sent_at:new Date().toISOString(),tracker_event_id:a(),tracker_user_id:this.getAnonymousId(),type:e};typeof document<"u"&&document.hidden?this.storeEvent(i):this.sendEvent(i)}getAnonymousId(){if(!this.storage)return a();let e=this.storage.getItem(v);if(typeof e<"u")return e;let n=a();return this.storage.setItem(v,n),n}async checkFlag(e,n){if(!n.company&&!n.user)return Promise.resolve(!1);let i=`https://api.schematichq.com/flags/${e}/check`,r=JSON.stringify(n);return fetch(i,{method:"POST",headers:{"X-Schematic-Api-Key":this.apiKey,"Content-Type":"application/json;charset=UTF-8"},body:r}).then(s=>{if(!s.ok)throw new Error("Network response was not ok");return s.json()}).then(s=>s.data.value).catch(s=>(console.error("There was a problem with the fetch operation:",s),!1))}async checkFlags(e){if(!e.company&&!e.user)return Promise.resolve({});let n="https://api.schematichq.com/flags/check",i=JSON.stringify(e);return fetch(n,{method:"POST",headers:{"X-Schematic-Api-Key":this.apiKey,"Content-Type":"application/json;charset=UTF-8"},body:i}).then(r=>{if(!r.ok)throw new Error("Network response was not ok");return r.json()}).then(r=>r.data.flags.reduce((s,p)=>(s[p.flag]=p.value,s))).catch(r=>(console.error("There was a problem with the fetch operation:",r),!1))}identify(e){this.handleEvent("identify",e)}track(e){this.handleEvent("track",e)}initialize(){typeof window<"u"&&window.addEventListener("beforeunload",()=>{this.flushEventQueue()})}};window.Schematic=c;})();
+/* @preserve */

package/dist/schematic.cjs.js

@@ -0,0 +1,214 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Schematic: () => Schematic
+});
+module.exports = __toCommonJS(src_exports);
+
+// node_modules/uuid/dist/esm-browser/rng.js
+var getRandomValues;
+var rnds8 = new Uint8Array(16);
+function rng() {
+  if (!getRandomValues) {
+    getRandomValues = typeof crypto !== "undefined" && crypto.getRandomValues && crypto.getRandomValues.bind(crypto);
+    if (!getRandomValues) {
+      throw new Error("crypto.getRandomValues() not supported. See https://github.com/uuidjs/uuid#getrandomvalues-not-supported");
+    }
+  }
+  return getRandomValues(rnds8);
+}
+
+// node_modules/uuid/dist/esm-browser/stringify.js
+var byteToHex = [];
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 256).toString(16).slice(1));
+}
+function unsafeStringify(arr, offset = 0) {
+  return (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + "-" + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + "-" + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + "-" + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + "-" + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase();
+}
+
+// node_modules/uuid/dist/esm-browser/native.js
+var randomUUID = typeof crypto !== "undefined" && crypto.randomUUID && crypto.randomUUID.bind(crypto);
+var native_default = {
+  randomUUID
+};
+
+// node_modules/uuid/dist/esm-browser/v4.js
+function v4(options, buf, offset) {
+  if (native_default.randomUUID && !buf && !options) {
+    return native_default.randomUUID();
+  }
+  options = options || {};
+  const rnds = options.random || (options.rng || rng)();
+  rnds[6] = rnds[6] & 15 | 64;
+  rnds[8] = rnds[8] & 63 | 128;
+  if (buf) {
+    offset = offset || 0;
+    for (let i = 0; i < 16; ++i) {
+      buf[offset + i] = rnds[i];
+    }
+    return buf;
+  }
+  return unsafeStringify(rnds);
+}
+var v4_default = v4;
+
+// src/index.ts
+var anonymousIdKey = "schematicId";
+var Schematic = class {
+  apiKey;
+  eventQueue;
+  storage;
+  constructor(apiKey, storage) {
+    this.apiKey = apiKey;
+    this.eventQueue = [];
+    if (storage) {
+      this.storage = storage;
+    } else if (typeof localStorage !== "undefined") {
+      this.storage = localStorage;
+    }
+  }
+  sendEvent(event) {
+    const captureUrl = "https://c.schematichq.com/e";
+    const payload = JSON.stringify(event);
+    fetch(captureUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json;charset=UTF-8"
+      },
+      body: payload
+    }).then((response) => {
+      if (!response.ok) {
+        throw new Error(
+          `Network response was not ok: ${response.statusText}`
+        );
+      }
+    }).catch((error) => {
+      console.error("There was a problem with the fetch operation:", error);
+    });
+  }
+  flushEventQueue() {
+    while (this.eventQueue.length > 0) {
+      const event = this.eventQueue.shift();
+      if (event) {
+        this.sendEvent(event);
+      }
+    }
+  }
+  storeEvent(event) {
+    this.eventQueue.push(event);
+  }
+  handleEvent(eventType, eventBody) {
+    const event = {
+      api_key: this.apiKey,
+      body: eventBody,
+      sent_at: (/* @__PURE__ */ new Date()).toISOString(),
+      tracker_event_id: v4_default(),
+      tracker_user_id: this.getAnonymousId(),
+      type: eventType
+    };
+    if (typeof document !== "undefined" && document.hidden) {
+      this.storeEvent(event);
+    } else {
+      this.sendEvent(event);
+    }
+  }
+  getAnonymousId() {
+    if (!this.storage) {
+      return v4_default();
+    }
+    const storedAnonymousId = this.storage.getItem(anonymousIdKey);
+    if (typeof storedAnonymousId !== "undefined") {
+      return storedAnonymousId;
+    }
+    const generatedAnonymousId = v4_default();
+    this.storage.setItem(anonymousIdKey, generatedAnonymousId);
+    return generatedAnonymousId;
+  }
+  async checkFlag(key, context) {
+    if (!context.company && !context.user) {
+      return Promise.resolve(false);
+    }
+    const requestUrl = `https://api.schematichq.com/flags/${key}/check`;
+    const requestBody = JSON.stringify(context);
+    return fetch(requestUrl, {
+      method: "POST",
+      headers: {
+        "X-Schematic-Api-Key": this.apiKey,
+        "Content-Type": "application/json;charset=UTF-8"
+      },
+      body: requestBody
+    }).then((response) => {
+      if (!response.ok) {
+        throw new Error("Network response was not ok");
+      }
+      return response.json();
+    }).then((data) => {
+      return data.data.value;
+    }).catch((error) => {
+      console.error("There was a problem with the fetch operation:", error);
+      return false;
+    });
+  }
+  async checkFlags(context) {
+    if (!context.company && !context.user) {
+      return Promise.resolve({});
+    }
+    const requestUrl = "https://api.schematichq.com/flags/check";
+    const requestBody = JSON.stringify(context);
+    return fetch(requestUrl, {
+      method: "POST",
+      headers: {
+        "X-Schematic-Api-Key": this.apiKey,
+        "Content-Type": "application/json;charset=UTF-8"
+      },
+      body: requestBody
+    }).then((response) => {
+      if (!response.ok) {
+        throw new Error("Network response was not ok");
+      }
+      return response.json();
+    }).then((data) => {
+      return data.data.flags.reduce((acc, flag) => {
+        acc[flag.flag] = flag.value;
+        return acc;
+      });
+    }).catch((error) => {
+      console.error("There was a problem with the fetch operation:", error);
+      return false;
+    });
+  }
+  identify(body) {
+    this.handleEvent("identify", body);
+  }
+  track(body) {
+    this.handleEvent("track", body);
+  }
+  initialize() {
+    if (typeof window !== "undefined") {
+      window.addEventListener("beforeunload", () => {
+        this.flushEventQueue();
+      });
+    }
+  }
+};
+/* @preserve */

package/dist/schematic.d.ts

@@ -0,0 +1,49 @@
+declare type EventBodyCompany = {
+    keys: Record<string, string>;
+    name?: string;
+    traits: Record<string, any>;
+};
+
+declare type EventBodyIdentify = {
+    company?: EventBodyCompany;
+    keys: Record<string, string>;
+    name?: string;
+    traits: Record<string, any>;
+};
+
+declare type EventBodyTrack = {
+    event: string;
+    traits: Record<string, any>;
+    company?: Record<string, string>;
+    user?: Record<string, string>;
+};
+
+declare type FlagCheckContext = {
+    company?: Record<string, string>;
+    user?: Record<string, string>;
+};
+
+export declare class Schematic {
+    private apiKey;
+    private eventQueue;
+    private storage;
+    constructor(apiKey: string, storage?: StoragePersister);
+    private sendEvent;
+    private flushEventQueue;
+    private storeEvent;
+    private handleEvent;
+    private getAnonymousId;
+    checkFlag(key: string, context: FlagCheckContext): Promise<boolean>;
+    checkFlags(context: FlagCheckContext): Promise<Record<string, boolean>>;
+    identify(body: EventBodyIdentify): void;
+    track(body: EventBodyTrack): void;
+    initialize(): void;
+}
+
+declare type StoragePersister = {
+    setItem(key: string, value: any): void;
+    getItem(key: string): any;
+    removeItem(key: string): void;
+};
+
+export { }

package/dist/schematic.esm.js

@@ -0,0 +1,191 @@
+// node_modules/uuid/dist/esm-browser/rng.js
+var getRandomValues;
+var rnds8 = new Uint8Array(16);
+function rng() {
+  if (!getRandomValues) {
+    getRandomValues = typeof crypto !== "undefined" && crypto.getRandomValues && crypto.getRandomValues.bind(crypto);
+    if (!getRandomValues) {
+      throw new Error("crypto.getRandomValues() not supported. See https://github.com/uuidjs/uuid#getrandomvalues-not-supported");
+    }
+  }
+  return getRandomValues(rnds8);
+}
+
+// node_modules/uuid/dist/esm-browser/stringify.js
+var byteToHex = [];
+for (let i = 0; i < 256; ++i) {
+  byteToHex.push((i + 256).toString(16).slice(1));
+}
+function unsafeStringify(arr, offset = 0) {
+  return (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + "-" + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + "-" + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + "-" + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + "-" + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase();
+}
+
+// node_modules/uuid/dist/esm-browser/native.js
+var randomUUID = typeof crypto !== "undefined" && crypto.randomUUID && crypto.randomUUID.bind(crypto);
+var native_default = {
+  randomUUID
+};
+
+// node_modules/uuid/dist/esm-browser/v4.js
+function v4(options, buf, offset) {
+  if (native_default.randomUUID && !buf && !options) {
+    return native_default.randomUUID();
+  }
+  options = options || {};
+  const rnds = options.random || (options.rng || rng)();
+  rnds[6] = rnds[6] & 15 | 64;
+  rnds[8] = rnds[8] & 63 | 128;
+  if (buf) {
+    offset = offset || 0;
+    for (let i = 0; i < 16; ++i) {
+      buf[offset + i] = rnds[i];
+    }
+    return buf;
+  }
+  return unsafeStringify(rnds);
+}
+var v4_default = v4;
+
+// src/index.ts
+var anonymousIdKey = "schematicId";
+var Schematic = class {
+  apiKey;
+  eventQueue;
+  storage;
+  constructor(apiKey, storage) {
+    this.apiKey = apiKey;
+    this.eventQueue = [];
+    if (storage) {
+      this.storage = storage;
+    } else if (typeof localStorage !== "undefined") {
+      this.storage = localStorage;
+    }
+  }
+  sendEvent(event) {
+    const captureUrl = "https://c.schematichq.com/e";
+    const payload = JSON.stringify(event);
+    fetch(captureUrl, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json;charset=UTF-8"
+      },
+      body: payload
+    }).then((response) => {
+      if (!response.ok) {
+        throw new Error(
+          `Network response was not ok: ${response.statusText}`
+        );
+      }
+    }).catch((error) => {
+      console.error("There was a problem with the fetch operation:", error);
+    });
+  }
+  flushEventQueue() {
+    while (this.eventQueue.length > 0) {
+      const event = this.eventQueue.shift();
+      if (event) {
+        this.sendEvent(event);
+      }
+    }
+  }
+  storeEvent(event) {
+    this.eventQueue.push(event);
+  }
+  handleEvent(eventType, eventBody) {
+    const event = {
+      api_key: this.apiKey,
+      body: eventBody,
+      sent_at: (/* @__PURE__ */ new Date()).toISOString(),
+      tracker_event_id: v4_default(),
+      tracker_user_id: this.getAnonymousId(),
+      type: eventType
+    };
+    if (typeof document !== "undefined" && document.hidden) {
+      this.storeEvent(event);
+    } else {
+      this.sendEvent(event);
+    }
+  }
+  getAnonymousId() {
+    if (!this.storage) {
+      return v4_default();
+    }
+    const storedAnonymousId = this.storage.getItem(anonymousIdKey);
+    if (typeof storedAnonymousId !== "undefined") {
+      return storedAnonymousId;
+    }
+    const generatedAnonymousId = v4_default();
+    this.storage.setItem(anonymousIdKey, generatedAnonymousId);
+    return generatedAnonymousId;
+  }
+  async checkFlag(key, context) {
+    if (!context.company && !context.user) {
+      return Promise.resolve(false);
+    }
+    const requestUrl = `https://api.schematichq.com/flags/${key}/check`;
+    const requestBody = JSON.stringify(context);
+    return fetch(requestUrl, {
+      method: "POST",
+      headers: {
+        "X-Schematic-Api-Key": this.apiKey,
+        "Content-Type": "application/json;charset=UTF-8"
+      },
+      body: requestBody
+    }).then((response) => {
+      if (!response.ok) {
+        throw new Error("Network response was not ok");
+      }
+      return response.json();
+    }).then((data) => {
+      return data.data.value;
+    }).catch((error) => {
+      console.error("There was a problem with the fetch operation:", error);
+      return false;
+    });
+  }
+  async checkFlags(context) {
+    if (!context.company && !context.user) {
+      return Promise.resolve({});
+    }
+    const requestUrl = "https://api.schematichq.com/flags/check";
+    const requestBody = JSON.stringify(context);
+    return fetch(requestUrl, {
+      method: "POST",
+      headers: {
+        "X-Schematic-Api-Key": this.apiKey,
+        "Content-Type": "application/json;charset=UTF-8"
+      },
+      body: requestBody
+    }).then((response) => {
+      if (!response.ok) {
+        throw new Error("Network response was not ok");
+      }
+      return response.json();
+    }).then((data) => {
+      return data.data.flags.reduce((acc, flag) => {
+        acc[flag.flag] = flag.value;
+        return acc;
+      });
+    }).catch((error) => {
+      console.error("There was a problem with the fetch operation:", error);
+      return false;
+    });
+  }
+  identify(body) {
+    this.handleEvent("identify", body);
+  }
+  track(body) {
+    this.handleEvent("track", body);
+  }
+  initialize() {
+    if (typeof window !== "undefined") {
+      window.addEventListener("beforeunload", () => {
+        this.flushEventQueue();
+      });
+    }
+  }
+};
+export {
+  Schematic
+};
+/* @preserve */

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@schematichq/schematic-js",
+  "main": "dist/schematic.cjs.js",
+  "module": "dist/schematic.esm.js",
+  "author": "Ben Papillon <ben@schematichq.com>",
+  "dependencies": {
+    "@types/uuid": "^9.0.2",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.38.3",
+    "@types/jest": "^29.5.11",
+    "@typescript-eslint/eslint-plugin": "^6.13.2",
+    "@typescript-eslint/parser": "^6.13.2",
+    "esbuild": "^0.19.9",
+    "esbuild-jest": "^0.5.0",
+    "eslint": "^8.55.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-esbuild": "^0.3.0",
+    "jest-fetch-mock": "^3.0.3",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.0.2"
+  },
+  "files": [
+    "dist/schematic.cjs.js",
+    "dist/schematic.esm.js",
+    "dist/schematic.browser.js",
+    "dist/schematic.d.ts"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/SchematicHQ/schematic-js.git"
+  },
+  "scripts": {
+    "build": "npx tsc && yarn clean && yarn build:browser && yarn build:cjs && yarn build:esm && yarn build:types",
+    "build:browser": "npx esbuild src/browser.ts --bundle --minify --outfile=dist/schematic.browser.js --platform=browser",
+    "build:cjs": "npx esbuild src/index.ts --bundle --format=cjs --outfile=dist/schematic.cjs.js --platform=neutral",
+    "build:esm": "npx esbuild src/index.ts --bundle --format=esm --outfile=dist/schematic.esm.js --platform=neutral",
+    "build:types": "npx tsc && npx api-extractor run",
+    "clean": "rm -rf dist",
+    "lint": "eslint src --ext ts,tsx --report-unused-disable-directives --fix",
+    "test": "jest --config jest.config.js"
+  },
+  "types": "dist/schematic.d.ts",
+  "version": "0.0.10"
+}