@lucida-analytics/angular 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
+

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# @lucida-analytics/angular
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`provideLucida()` registers an injectable `LucidaService` over the browser SDK (flags as `flags$` / `flag$(key)`, `client`
+for everything else). It is a plain class, so no Angular compiler plugin is needed.
+
+```ts
+// main.ts
+bootstrapApplication(App, { providers: [provideLucida({ apiKey: "lc_pk_...", options: { consent: { mode: "opt_in" } } })] });
+```
+
+## Server-side rendering (Angular Universal / `@angular/ssr`)
+
+- The service never touches the browser SDK on the server: with no `window` it creates no client and every call is a
+  no-op, so it is safe in `app.config.server.ts` and in server-rendered components. Nothing is sent, stored or timed on the server.
+- Pageviews and the first-party id start after hydration. To avoid a flag flash, resolve flags on the server and pass them in:
+
+  ```ts
+  // server.ts (Express): evaluate once per request with the edge client
+  import { createEdgeClient, requestBootstrap } from "@lucida-analytics/edge";
+  const lucida = createEdgeClient({ apiKey: "lc_pk_...", host: "https://capture.lucidace.com" });
+  app.get("*", async (req, res, next) => {
+    const b = await requestBootstrap(lucida, req.headers.cookie, { consentMode: "opt_in" });
+    if (b.setCookie) res.append("Set-Cookie", b.setCookie);
+    // hand the bootstrap to the app through an injection token
+    commonEngine.render({ ..., providers: [{ provide: LUCIDA_BOOTSTRAP, useValue: b }] }).then((html) => res.send(html));
+  });
+
+  // app.config.ts
+  provideLucida({ apiKey: "lc_pk_...", options: { bootstrap: { distinctId: b.distinctId } }, bootstrapFlags: b.flags })
+  ```
+
+  `bootstrapFlags` render on the server and in the first client render, so the page does not flicker from the control to a variant.
+- Do the lookup in a factory (`useFactory` with `inject(LUCIDA_BOOTSTRAP, { optional: true })`) so the same `app.config.ts`
+  serves the browser build with no bootstrap.
+- Session replay and autocapture only run in the browser; do not call `client.replay.start()` from server code.
+- Server-side events (API routes in the same Express app): use `@lucida-analytics/node`, and read the visitor with
+  `requestContext` from `@lucida-analytics/node`, which understands the `X-Lucida-Distinct-Id` / `X-Lucida-Session-Id` headers the browser SDK sends
+  when you list your API host in `tracingHeaders`. Those headers are client-controlled: stitch analytics, never authenticate.
+- Consent: the anonymous-id cookie from `requestBootstrap` is only emitted when consent allows (`consentMode`).

package/dist/index.d.ts

@@ -0,0 +1,58 @@
+import { FlagValue, Client, BrowserConfig } from '@lucida-analytics/browser';
+
+type Flags = Record<string, FlagValue>;
+/** Anything RxJS, `AsyncPipe` and `toSignal()` can subscribe to (no rxjs dependency here). */
+interface Subscribable<T> {
+    subscribe(observer: (value: T) => void): {
+        unsubscribe(): void;
+    };
+}
+interface LucidaConfig {
+    /** An existing client (tests, shared instance). */
+    client?: Client;
+    apiKey?: string;
+    options?: BrowserConfig;
+    /** Server-resolved flags for the first render. */
+    bootstrapFlags?: Flags;
+}
+/**
+ * Injectable facade over the browser SDK. It is a plain class (no decorators), registered by
+ * `provideLucida()`, so it needs no Angular compiler plugin or JIT metadata. The SDK is never
+ * touched on the server (no `window`): every call is then a no-op. Angular calls `ngOnDestroy`.
+ * Flag changes arrive from SDK callbacks outside Angular's zone; read them through `flags$`
+ * with the async pipe (which schedules its own change detection).
+ */
+declare class LucidaService {
+    readonly client: Client | null;
+    private flags;
+    private readonly listeners;
+    private readonly stop;
+    constructor(c: LucidaConfig);
+    /** All flags; emits the current value on subscribe, then on every reload. */
+    readonly flags$: Subscribable<Flags>;
+    /** One flag's value, emitting only when it changes. */
+    flag$(key: string): Subscribable<FlagValue | undefined>;
+    capture(event: string, props?: Parameters<Client["capture"]>[1]): void;
+    identify(...a: Parameters<Client["identify"]>): void;
+    reset(): void;
+    setConsent(u: Parameters<Client["setConsent"]>[0]): void;
+    getFlag(key: string): FlagValue | undefined;
+    isFeatureEnabled(key: string): boolean;
+    /** Recording control; inert on the server. */
+    get replay(): Client["replay"] | undefined;
+    ngOnDestroy(): void;
+}
+
+/** A provider literal Angular's `providers: []` accepts, typed locally so no Angular import is needed. */
+interface LucidaProvider {
+    provide: typeof LucidaService;
+    useFactory: () => LucidaService;
+}
+/**
+ * Standalone API: `bootstrapApplication(App, { providers: [provideLucida({ apiKey, options })] })`
+ * (or `providers` of any NgModule). Inject with `inject(LucidaService)`. The service is created
+ * lazily on first injection; inject it once at startup (e.g. an APP_INITIALIZER) to capture the first pageview early.
+ */
+declare function provideLucida(config: LucidaConfig): LucidaProvider[];
+
+export { type Flags, type LucidaConfig, type LucidaProvider, LucidaService, type Subscribable, provideLucida };

package/dist/index.js

@@ -0,0 +1,72 @@
+// src/service.ts
+import { init } from "@lucida-analytics/browser";
+var LucidaService = class {
+  client;
+  flags;
+  listeners = /* @__PURE__ */ new Set();
+  stop;
+  constructor(c) {
+    this.client = c.client ?? (c.apiKey && typeof window !== "undefined" ? init(c.apiKey, { ...c.options, ...c.bootstrapFlags ? { bootstrap: { ...c.options?.bootstrap, flags: c.bootstrapFlags } } : {} }) : null);
+    this.flags = c.bootstrapFlags ?? {};
+    this.stop = this.client?.onFlags((f) => {
+      this.flags = f;
+      this.listeners.forEach((l) => l(f));
+    });
+  }
+  /** All flags; emits the current value on subscribe, then on every reload. */
+  flags$ = {
+    subscribe: (observer) => {
+      this.listeners.add(observer);
+      observer(this.flags);
+      return { unsubscribe: () => void this.listeners.delete(observer) };
+    }
+  };
+  /** One flag's value, emitting only when it changes. */
+  flag$(key) {
+    return {
+      subscribe: (observer) => {
+        let last = /* @__PURE__ */ Symbol();
+        return this.flags$.subscribe((f) => {
+          if (f[key] === last) return;
+          last = f[key];
+          observer(f[key]);
+        });
+      }
+    };
+  }
+  capture(event, props) {
+    this.client?.capture(event, props);
+  }
+  identify(...a) {
+    this.client?.identify(...a);
+  }
+  reset() {
+    this.client?.reset();
+  }
+  setConsent(u) {
+    this.client?.setConsent(u);
+  }
+  getFlag(key) {
+    return this.client?.getFlag(key);
+  }
+  isFeatureEnabled(key) {
+    return this.client?.isFeatureEnabled(key) ?? false;
+  }
+  /** Recording control; inert on the server. */
+  get replay() {
+    return this.client?.replay;
+  }
+  ngOnDestroy() {
+    this.stop?.();
+    this.listeners.clear();
+  }
+};
+
+// src/provide.ts
+function provideLucida(config) {
+  return [{ provide: LucidaService, useFactory: () => new LucidaService(config) }];
+}
+export {
+  LucidaService,
+  provideLucida
+};

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@lucida-analytics/angular",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lucidaanalytics/lucida-js.git",
+    "directory": "packages/angular"
+  },
+  "homepage": "https://github.com/lucidaanalytics/lucida-js/tree/main/packages/angular",
+  "bugs": "https://github.com/lucidaanalytics/lucida-js/issues",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@angular/core": ">=16",
+    "@lucida-analytics/browser": "^0.1.4"
+  },
+  "peerDependenciesMeta": {
+    "@angular/core": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "jsdom": "^26.1.0",
+    "tsup": "^8.5.0",
+    "@lucida-analytics/browser": "0.1.4"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsgo --noEmit",
+    "test": "vitest run"
+  }
 }