@faynosync/sdk-js 0.1.0

package/.github/workflows/create-release.yml

@@ -0,0 +1,80 @@
+name: Create Release
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
+  create-release:
+    needs: test
+    if: |
+      github.event_name == 'workflow_dispatch' || contains(github.event.head_commit.message, 'commit new version') == true
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
+
+      - name: Extract Version
+        id: extract-version
+        run: |
+          version=$(grep -m 1 -oP '## v\d+\.\d+\.\d+' CHANGELOG.md | cut -d ' ' -f 2)
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+      - name: Extract Changelog
+        id: extract-changelog
+        run: |
+          changelog=$(awk '/^## v[0-9]+\.[0-9]+\.[0-9]+/{if (!version) {version=$0; next}} /^## v[0-9]+\.[0-9]+\.[0-9]+/{exit} {if (version) description = description ORS $0} END {if (version) print description}' CHANGELOG.md | sed -e '/^## v[0-9]+\.[0-9]+\.[0-9]+/d; s/^# //' > changelog.txt)
+          echo "changelog_file=changelog.txt" >> "$GITHUB_OUTPUT"
+
+      - name: Create Release
+        id: create-release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.extract-version.outputs.version }}
+          release_name: ${{ steps.extract-version.outputs.version }}
+          body_path: ${{ steps.extract-changelog.outputs.changelog_file }}
+          draft: false
+          prerelease: false
+
+      - name: Publish to npm
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 0.1.0
+
+Initial release of the faynoSync JS SDK (transport layer only).
+
+### Added
+
+- `Client` with `checkForUpdates` against the Base API (`GET /checkVersion`)
+- Optional `edgeURL` static JSON lookup with automatic API fallback
+- Typed `CheckOptions`, `UpdateResponse`, and package URL decoding
+- `EndpointError` and `CheckError` for typed request failure handling
+- Sentinel validation errors for missing/invalid configuration
+- Optional `systemPlatform` / `systemArch` helpers (Node.js `process.platform` / `process.arch`)
+- `AbortSignal` support for request cancellation
+- Custom `fetch` support for transport customization (`timeoutMs`, keep-alive, proxies)
+- Examples: basic, edge fallback, custom fetch

package/LICENSE

@@ -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 [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

@@ -0,0 +1,259 @@
+# faynoSync JS SDK
+
+Production-oriented JavaScript/TypeScript SDK for checking application updates with faynoSync.
+
+This package is a small typed transport and developer experience layer. It does not implement update installation, platform normalization, metadata verification, caching, or business rules.
+
+## Requirements
+
+Node.js 18 or later.
+
+## Installation
+
+```sh
+npm install @faynosync/sdk-js
+```
+
+## Quick Start
+
+```ts
+import { Client } from '@faynosync/sdk-js';
+
+const client = new Client({
+  baseURL: 'https://api.example.com',
+});
+
+const resp = await client.checkForUpdates({
+  owner: 'admin',
+  appName: 'test',
+  version: '0.0.0.5',
+  channel: 'nightly',
+  platform: 'darwin',
+  arch: 'arm64',
+});
+
+if (resp.updateAvailable) {
+  if (resp.updateUrl !== '') {
+    console.log('Update available:', resp.updateUrl);
+  }
+  for (const pkg of resp.packageUrls) {
+    console.log(`${pkg.package} update available:`, pkg.url);
+  }
+}
+```
+
+## Configuration
+
+```ts
+import { Client } from '@faynosync/sdk-js';
+
+const client = new Client({
+  baseURL: 'https://api.example.com',
+  edgeURL: 'https://cdn.example.com',
+  timeoutMs: 10_000,
+  fetch: customFetch,
+});
+```
+
+`baseURL` is required. It points to the faynoSync API.
+
+`edgeURL` is optional. When configured, the SDK tries a static edge JSON response before falling back to the API.
+
+`timeoutMs` is optional. Defaults to `30000`. Applied to every request.
+
+`fetch` is optional. When omitted, the SDK uses `globalThis.fetch` (Node.js 18+ built-in). Supply a custom function to configure proxies, connection pooling, or logging.
+
+The client is safe for concurrent use.
+
+## Update Checks
+
+`checkForUpdates` returns a typed response:
+
+```ts
+const resp = await client.checkForUpdates({
+  owner: 'admin',
+  appName: 'test',
+  version: '0.0.0.5',
+  channel: 'nightly',
+  platform: 'darwin',
+  arch: 'arm64',
+  deviceId: 'optional-device-id',
+});
+```
+
+`deviceId` is optional. When set, the SDK sends it as the `X-Device-ID` header and triggers a telemetry beacon after a successful edge response.
+
+An optional `AbortSignal` can be passed as the second argument to cancel the request:
+
+```ts
+const controller = new AbortController();
+setTimeout(() => controller.abort(), 5_000);
+
+const resp = await client.checkForUpdates(opts, controller.signal);
+```
+
+## Base API Request
+
+The `baseURL` API request uses `GET /checkVersion`:
+
+```
+GET /checkVersion?app_name=test&version=0.0.0.5&channel=nightly&platform=darwin&arch=arm64&owner=admin
+X-Device-ID: optional
+```
+
+## Response Model
+
+faynoSync may return a direct binary update URL:
+
+```json
+{
+  "update_available": true,
+  "update_url": "https://downloads.example.com/app"
+}
+```
+
+It may also return package-specific URLs with dynamic field names:
+
+```json
+{
+  "update_available": true,
+  "update_url_deb": "https://downloads.example.com/app.deb",
+  "update_url_rpm": "https://downloads.example.com/app.rpm",
+  "changelog": "### Changelog\n\n- Added feature X",
+  "critical": true,
+  "is_intermediate_required": true,
+  "possible_rollback": true
+}
+```
+
+The SDK decodes these into a typed `UpdateResponse`:
+
+```ts
+if (resp.updateUrl !== '') {
+  console.log(resp.updateUrl);
+}
+
+for (const pkg of resp.packageUrls) {
+  console.log(pkg.package, pkg.url);
+}
+```
+
+`packageUrls` is always sorted alphabetically by package name.
+
+`source` identifies where the response came from: `'edge'`, `'api'`, or `'unknown'`.
+
+## EdgeURL Fallback
+
+When `edgeURL` is configured, the SDK first tries a static JSON response:
+
+```
+GET /responses/{owner}/{appName}/{channel}/{platform}/{arch}/{version}.json
+```
+
+For example:
+
+```
+GET /responses/admin/test/nightly/darwin/arm64/0.0.0.5.json
+```
+
+If the edge response succeeds with HTTP 200 and valid JSON, `resp.source` is `'edge'`.
+
+The SDK falls back to the `baseURL` API when the edge request has:
+
+- a network error
+- a timeout
+- invalid JSON
+- HTTP 404
+- any other non-200 response
+
+If the fallback API succeeds, `resp.source` is `'api'`.
+
+## Platform, Channel, and Architecture Values
+
+faynoSync supports fully custom platform, channel, and architecture values. This SDK never normalizes or remaps them.
+
+The SDK will not change values such as:
+
+- `macos` to `darwin`
+- `osx` to `darwin`
+- `stable` to `default`
+
+Whatever string you pass in `channel`, `platform`, and `arch` is the string sent to faynoSync.
+
+## Optional System Helpers
+
+The SDK provides optional helpers that return the current Node.js runtime values:
+
+```ts
+import { systemPlatform, systemArch } from '@faynosync/sdk-js';
+
+const platform = systemPlatform(); // process.platform — e.g. 'darwin', 'linux', 'win32'
+const arch     = systemArch();     // process.arch    — e.g. 'arm64', 'x64'
+```
+
+These helpers are never called automatically. Use them only when Node.js runtime values match your faynoSync configuration.
+
+## Error Handling
+
+The SDK validates required fields and throws typed errors:
+
+```ts
+import {
+  Client,
+  RequestFailedError,
+  EndpointError,
+  CheckError,
+  ErrMissingBaseURL,
+  ErrMissingOwner,
+  ErrMissingAppName,
+  ErrMissingVersion,
+} from '@faynosync/sdk-js';
+
+try {
+  const resp = await client.checkForUpdates(opts);
+} catch (err) {
+  if (err === ErrMissingBaseURL) {
+    // configure Client baseURL
+  } else if (err === ErrMissingOwner) {
+    // set opts.owner
+  } else if (err === ErrMissingAppName) {
+    // set opts.appName
+  } else if (err === ErrMissingVersion) {
+    // set opts.version
+  } else if (err instanceof RequestFailedError) {
+    // all endpoints failed — inspect for details
+    if (err instanceof CheckError) {
+      console.error('edge error:', err.edgeError?.message);
+      console.error('api error:', err.apiError?.message);
+    }
+    if (err instanceof EndpointError) {
+      console.error('url:', err.endpointUrl);
+      console.error('status:', err.statusCode);
+    }
+  }
+}
+```
+
+Validation errors (`ErrMissing*`, `ErrInvalid*`) are singleton instances — use `===` to check them. Request failures are class instances — use `instanceof` to narrow them.
+
+## Examples
+
+Runnable examples are available in:
+
+- [`examples/basic`](examples/basic) — minimal setup using runtime platform/arch detection
+- [`examples/edge-fallback`](examples/edge-fallback) — `edgeURL` configured with `deviceId` telemetry
+- [`examples/custom-fetch`](examples/custom-fetch) — custom `fetch` function and `timeoutMs`
+
+Run any example with:
+
+```sh
+npx ts-node examples/basic/index.ts
+```
+
+## Security Scope
+
+This SDK version performs update-check transport requests and typed response decoding only.
+
+It does not verify TUF metadata, signatures, thresholds, expiration, rollback protection, or cache safety. Applications that need secure update metadata verification must perform that verification in the appropriate faynoSync component or a future SDK layer that explicitly implements it.
+
+No signature, threshold, expiration, rollback, freeze, root-of-trust, or cache protection is weakened by this transport-only SDK.

package/dist/client.d.ts

@@ -0,0 +1,24 @@
+import type { CheckOptions, UpdateResponse } from './types';
+export interface Config {
+    readonly baseURL: string;
+    readonly edgeURL?: string;
+    readonly fetch?: typeof globalThis.fetch;
+    readonly timeoutMs?: number;
+}
+export declare class Client {
+    private readonly baseURL;
+    private readonly edgeURL;
+    private readonly fetchFn;
+    private readonly timeoutMs;
+    constructor(cfg: Config);
+    checkForUpdates(opts: CheckOptions, signal?: AbortSignal): Promise<UpdateResponse>;
+    private validateConfig;
+    private checkEdge;
+    private checkAPI;
+    private doUpdateRequest;
+    private buildAPICheckURL;
+    private buildEdgeCheckURL;
+    private buildEdgeTelemetryBeaconURL;
+    private sendEdgeTelemetryBeacon;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAoB,cAAc,EAAgB,MAAM,SAAS,CAAC;AAgB5F,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAYD,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEvB,GAAG,EAAE,MAAM;IAOjB,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;IAkCxF,OAAO,CAAC,cAAc;YAOR,SAAS;YAKT,QAAQ;YAKR,eAAe;IAsC7B,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,iBAAiB;IAezB,OAAO,CAAC,2BAA2B;YAerB,uBAAuB;CAkBtC"}