@useairfoil/producer-polar 0.3.0 → 0.3.2

package/LICENSE.txt

@@ -0,0 +1,201 @@
+
+                                 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 2026 GNC Labs Limited
+
+    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,221 +1,65 @@
-# @useairfoil/producer-polar
+# Polar producer
 
-Polar producer connector for Airfoil Connector Kit.
+This connector backfills Polar customers, checkouts, orders, subscriptions,
+refunds, products, and discounts.
+It gets live events at `POST /webhooks/polar`.
 
-Current scope:
+## Config
 
-- entities: `customers`, `checkouts`, `orders`, `subscriptions`
-- backfill source: Polar REST API
-- live source: Polar webhooks on `/webhooks/polar`
+| Variable                | Required    | Default |
+| ----------------------- | ----------- | ------- |
+| `POLAR_ACCESS_TOKEN`    | yes         | none    |
+| `POLAR_WEBHOOK_SECRET`  | yes         | none    |
+| `POLAR_API_BASE_URL`    | hosted only | none    |
+| `POLAR_ORGANIZATION_ID` | no          | none    |
 
-## Public Exports
+## Setup
 
-- root: `PolarApiClient`, `PolarConnector`, entity schemas, webhook schema, and schema-derived types
-- manifest subpath: `@useairfoil/producer-polar/manifest` exports browser-safe connector metadata
+Create a [Polar organization access token](https://docs.polar.sh/integrate/oat)
+with `customers:read`, `checkouts:read`, `orders:read`, `subscriptions:read`,
+`refunds:read`, `products:read`, and `discounts:read`. Use it as
+`POLAR_ACCESS_TOKEN`.
 
-Typical imports:
+Create a webhook endpoint for `/webhooks/polar` and use its signing secret as
+`POLAR_WEBHOOK_SECRET`. Sandbox tokens and webhooks must come from the Polar
+sandbox. Subscribe it to the `customer.*`, `checkout.*`, `order.*`,
+`subscription.*`, `refund.*`, `product.*`, and `discount.*` events. The
+connector acknowledges other events without storing them.
 
-```ts
-import { CustomerSchema, PolarConnector, type Customer } from "@useairfoil/producer-polar";
-import { PolarApiClient, WebhookPayloadSchema } from "@useairfoil/producer-polar";
-```
-
-Connector config and runtime types are exported from the `PolarConnector` namespace.
-
-## ConnectorApp Shape
-
-`PolarConnector` is a typed Effect service with `layer(config)` and `layerConfig(config)`. Runtime and dashboard validation both use `layerConfig(PolarConfigDef.config)`. Local sandbox runs use `layerConfig(...)` with a `Config.succeed("https://sandbox-api.polar.sh/v1/")` override for `apiBaseUrl`.
+## API version
 
-## Configuration
+The connector pins Polar API version `2026-10` with the `Polar-Version` header.
+Set the webhook endpoint API version to `2026-10`.
 
-The sandbox reads connector values from the environment:
+## Limits
 
-```env
-POLAR_ACCESS_TOKEN=polar_oat_xxx
-POLAR_WEBHOOK_SECRET=polar_whs_xxx
-```
+Deleted products stay in the `products` table because Polar has no
+`product.deleted` webhook. Subscriptions without `started_at` can be missed
+during a backfill because Polar has no stable sort for them. After backfill,
+updates depend on webhooks. Missed webhook deliveries are not recovered yet.
 
-The sandbox injects the Polar sandbox API URL. Hosted `start` instead requires a read-only connector JSON file selected by `AIRFOIL_CONFIG_PATH`; matching environment values override file values per key. The file includes manifest runtime keys such as `POLAR_ACCESS_TOKEN` and `POLAR_API_BASE_URL`.
+## Demo data
 
-```env
-POLAR_API_BASE_URL=https://api.polar.sh/v1/
-```
+`pnpm demo --size 128MiB` writes made-up Polar data without a Polar token. See
+the Connector Kit README for the flags and the variables it needs.
 
-Optional:
-
-```env
-POLAR_ORGANIZATION_ID=org_xxx
-# Defaults to 100 for sandbox and 500 for production.
-# POLAR_RATE_LIMIT_PER_MINUTE=500
-# POLAR_TRANSIENT_MAX_RETRIES=5
-# POLAR_RETRY_BASE_DELAY_MS=200
-# POLAR_REQUEST_TIMEOUT_SECONDS=120
-AIRFOIL_HTTP_PORT=8080
-OTEL_ENABLED=false
-OTEL_SERVICE_NAME=producer-polar
-# OTEL_SERVICE_VERSION=0.1.0
-# OTEL_RESOURCE_ATTRIBUTES=service.instance.id=team-acme-polar-primary,airfoil.connector.revision=1,airfoil.team.id=team-acme
-OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
-OTEL_EXPORTER_OTLP_HEADERS=Authorization=Bearer token,X-Axiom-Dataset=airfoil-traces
-```
+Each customer has checkouts, subscriptions, orders, and refunds that point to
+each other and to a fixed catalog of 6 products and 3 discounts. `products` and
+`discounts` don't grow with the size.
 
-The API policy is loaded with the rest of the connector config. It is applied per connector process, so separate instances using the same Polar token do not share one request budget.
+## Local development
 
-Production `start` also requires platform-owned Wings, table, and PostgreSQL state config:
-
-```env
-WINGS_HOST=localhost:7777
-WINGS_NAMESPACE=namespaces/default
-AIRFOIL_TABLE_BINDINGS={"customers":"namespaces/default/tables/polar-customers","checkouts":"namespaces/default/tables/polar-checkouts","orders":"namespaces/default/tables/polar-orders","subscriptions":"namespaces/default/tables/polar-subscriptions"}
-AIRFOIL_CONFIG_PATH=/var/run/airfoil/config/config.json
-AIRFOIL_CONNECTOR_INSTANCE_ID=team-acme-polar-primary
-# AIRFOIL_STATE_TABLE=_airfoil_connectors_state
-POSTGRES_CONNECTION_STRING=postgresql://...
-```
-
-The sandbox uses `Telemetry.layerOtlp()` and `Telemetry.layerMetricsConsoleDump()` from Connector Kit. Connector Kit reads `OTEL_ENABLED`, `OTEL_EXPORTER_OTLP_ENDPOINT`, and `OTEL_EXPORTER_OTLP_HEADERS` for OTLP trace/metric export. Effect reads `OTEL_SERVICE_NAME`, `OTEL_SERVICE_VERSION`, and `OTEL_RESOURCE_ATTRIBUTES` for resource metadata. HTTP runtimes expose shallow process health at `GET /health`, metrics at `GET /metrics`, and durable progress or source errors at `GET /status`.
-
-## ConnectorApp Entrypoint
-
-The package scripts run the connector CLI from source:
+The sandbox uses the Polar sandbox API.
 
 ```bash
-pnpm --filter @useairfoil/producer-polar run sandbox
-pnpm --filter @useairfoil/producer-polar run start
+cd connectors/producer-polar
+pnpm sandbox
 ```
 
-`sandbox` runs the real connector against Polar sandbox with `Publisher.layerConsole`. `start` runs against the configured `POLAR_API_BASE_URL` and loads the complete platform-owned Wings map through `Publisher.layerWingsConfig`.
-
-The CLI assembly lives in `src/main.ts`; production runtime wiring lives in `src/start.ts`; sandbox runtime wiring lives in `src/sandbox.ts`. Port and table bindings use Connector Kit's shared platform keys.
-
-Before provisioning, the dashboard backend passes `PolarConnector.PolarConnector` and `PolarConnector.layerConfig(PolarConnector.PolarConfigDef.config)` to `ConnectorApp.check(...)`. Each selected entity performs a read-only one-item request against its corresponding Polar list endpoint; unselected entities are not contacted.
-
-## Production Image
-
-The build emits a separate `dist/main.js` CLI while keeping it outside the package exports. Build and smoke-test the non-root Node 24 image through Nx:
+A hosted run loads connector config from `AIRFOIL_CONFIG_PATH`. It also needs
+the Wings and PostgreSQL variables from the Connector Kit README.
 
 ```bash
-pnpm nx run @useairfoil/producer-polar:docker:build
-docker run --rm airfoil/producer-polar:local --help
+cd connectors/producer-polar
+pnpm start
 ```
-
-The image runs `node dist/main.js start`, exposes port `8080`, and contains only the pruned production package. Mount the complete connector JSON file read-only at the path supplied by `AIRFOIL_CONFIG_PATH`; inject the platform-owned values listed above separately. Never bake `.env`, access tokens, webhook secrets, or database credentials into the image. The operator owns Kubernetes readiness and liveness probes against `/health`.
-
-## Minimal ConnectorApp Wiring
-
-The following is local/example wiring. Hosted production uses `RuntimeConfig.layerHosted()`, `StateStore.layerSql()` over `PgClient`, and the Wings publisher as shown by `src/start.ts`; it must not fall back to memory state.
-
-```ts
-import { Publisher, ConnectorApp, StateStore, Telemetry } from "@useairfoil/connector-kit";
-import { Effect, Layer } from "effect";
-import { FetchHttpClient } from "effect/unstable/http";
-
-import { PolarConnector } from "@useairfoil/producer-polar";
-
-const BootstrapLayer = FetchHttpClient.layer;
-
-const ConnectorLayer = PolarConnector.layerConfig(PolarConnector.PolarConfigDef.config).pipe(
-  Layer.provide(BootstrapLayer),
-);
-const TelemetryLayer = Telemetry.layerOtlp().pipe(Layer.provide(BootstrapLayer));
-
-const program = Effect.gen(function* () {
-  const connector = yield* PolarConnector.PolarConnector;
-  return yield* ConnectorApp.start(connector, { port: 8080 });
-});
-
-const RuntimeLayer = Layer.mergeAll(
-  StateStore.layerMemory,
-  Publisher.layerConsole,
-  ConnectorLayer,
-  TelemetryLayer,
-);
-
-const runnable = Effect.scoped(program).pipe(Effect.provide(RuntimeLayer));
-
-Effect.runPromise(runnable);
-```
-
-## Webhook Behavior
-
-- webhook path: `POST /webhooks/polar`
-- route payloads are schema-validated through `Webhook.route(...)`
-- `POLAR_WEBHOOK_SECRET` is required and every signature is verified against the raw request body
-- webhook upserts use the event timestamp as their Wings version
-- `customer.deleted` emits a delete mutation
-- subscription pause and resume events are supported
-
-## API Client Layer
-
-`PolarApiClient.layer(config)` builds `PolarApiClient.PolarApiClient` from a raw `PolarConfig` value.
-
-This is useful for focused API tests or custom runtimes that do not need the full connector service.
-
-```ts
-import { Effect, Layer, Option, Redacted, Schema } from "effect";
-import { FetchHttpClient } from "effect/unstable/http";
-
-import { PolarApiClient } from "@useairfoil/producer-polar";
-
-const apiLayer = PolarApiClient.layer({
-  accessToken: Redacted.make("test"),
-  apiBaseUrl: "https://sandbox-api.polar.sh/v1/",
-  organizationId: Option.none(),
-  rateLimitPerMinute: Option.none(),
-  transientMaxRetries: 5,
-  retryBaseDelayMs: 200,
-  requestTimeoutSeconds: 120,
-  webhookSecret: Redacted.make("test-webhook-secret"),
-}).pipe(Layer.provide(FetchHttpClient.layer));
-
-const program = PolarApiClient.PolarApiClient.use((api) =>
-  api.fetchList(Schema.Any, "customers/", {
-    page: 1,
-    limit: 100,
-    sorting: "-created_at",
-  }),
-).pipe(Effect.provide(apiLayer));
-
-Effect.runPromise(program);
-```
-
-## Development Notes
-
-- Polar entity streams combine live webhook events with paginated backfill
-- backfill is bounded by the cutoff established from live webhooks or the initial runtime cutoff
-- backfill pagination stays on `created_at`; decoded rows use `modified_at ?? created_at` as their version
-- incoming events outside the current connector scope are ignored
-
-## Testing
-
-- `test/api.vcr.test.ts`: VCR-backed API replay against a recorded cassette
-- `test/check.test.ts`, `test/schemas.test.ts`, and `test/rate-limit.test.ts`: config checks, provider schemas, and request policy
-- `test/webhook.test.ts`: in-memory webhook round-trip using `NodeHttpServer.layerTest`
-
-Run:
-
-```bash
-pnpm --filter @useairfoil/producer-polar run test:ci
-```
-
-## Sandbox Tracing
-
-Set `OTEL_ENABLED=true` to export traces and metrics from the sandbox. Metrics are also logged locally by `Telemetry.layerMetricsConsoleDump()`.
-
-The sandbox uses `Telemetry.layerOtlp()` with the default Connector Kit sensitive-header redaction. See `@useairfoil/connector-kit` for the full telemetry env var list, metric names, and redaction defaults.
-
-For local Jaeger with persistent storage, start it from the traceview package:
-
-```bash
-pnpm --filter @useairfoil/traceview run jaeger:up
-```
-
-Then set `OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318` and run the sandbox. After triggering a webhook or backfill, render the trace:
-
-```bash
-traceview <trace-id> --source jaeger
-# or for Axiom:
-traceview <trace-id> --source axiom
-```
-
-Webhook traces may include an external parent span from Polar's `traceparent` header — that parent is expected to be missing from your dataset unless Polar also exports there.