@hot-updater/neon 0.0.0-stage → 1.1.5

package/LICENSE

@@ -0,0 +1,33 @@
+MIT License
+
+Copyright (c) 2023 Sungyu Kang 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+ADDITIONAL DISCLAIMER
+
+The authors of this software shall not be held responsible for any legal issues,
+regulatory violations, policy violations, or disputes arising from the use,
+distribution, or integration of this software.
+
+Users are solely responsible for ensuring compliance with all applicable laws,
+regulations, and third-party policies (including but not limited to app store
+policies).

package/dist/index.cjs

@@ -0,0 +1,39 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _hot_updater_storage_s3 = require("@hot-updater/storage-s3");
+let _hot_updater_postgres = require("@hot-updater/postgres");
+//#region src/neonStorage.ts
+/** The endpoint's origin, or an error that names the variable to set. */
+const endpointOrigin = (endpoint) => {
+	let url;
+	try {
+		url = new URL(endpoint);
+	} catch {
+		throw new Error("neonStorage needs the branch's storage endpoint (AWS_ENDPOINT_URL_S3), such as https://br-xxx.storage.c-5.us-east-2.aws.neon.tech.");
+	}
+	if (url.pathname !== "/" && url.pathname !== "") throw new Error(`neonStorage endpoint must not include a path: pass the bucket as bucketName instead of "${url.pathname}".`);
+	return url.origin;
+};
+/**
+* Bundles in a Neon Object Storage bucket, through its S3 API. Devices
+* download from presigned URLs that expire, so a private bucket works.
+*/
+const neonStorage = (config) => {
+	const { endpoint, region, ...s3Config } = config;
+	return (0, _hot_updater_storage_s3.createS3Storage)({
+		name: "neonStorage",
+		protocol: "neon"
+	}, {
+		...s3Config,
+		endpoint: endpointOrigin(endpoint),
+		forcePathStyle: true,
+		region: region ?? "us-east-1"
+	});
+};
+//#endregion
+exports.neonStorage = neonStorage;
+Object.defineProperty(exports, "postgres", {
+	enumerable: true,
+	get: function() {
+		return _hot_updater_postgres.postgres;
+	}
+});

package/dist/index.d.cts

@@ -0,0 +1,33 @@
+import { StorageAdapterWith } from "@hot-updater/plugin-core";
+import { S3ClientConfig, S3StorageOperations } from "@hot-updater/storage-s3";
+import { PostgresConfig, postgres } from "@hot-updater/postgres";
+//#region src/neonStorage.d.ts
+interface NeonStorageConfig extends Omit<S3ClientConfig, "credentials" | "endpoint" | "forcePathStyle"> {
+  /**
+   * The branch's object storage endpoint, such as
+   * `https://br-xxx.storage.c-5.us-east-2.aws.neon.tech`: the
+   * `AWS_ENDPOINT_URL_S3` that `neon env pull` writes.
+   */
+  endpoint: string;
+  /** The bucket on that branch. */
+  bucketName: string;
+  /**
+   * A storage credential of the project: the `AWS_ACCESS_KEY_ID` and
+   * `AWS_SECRET_ACCESS_KEY` that `neon env pull` writes.
+   */
+  credentials: NonNullable<S3ClientConfig["credentials"]>;
+  /** Base path where bundles will be stored in the bucket. */
+  basePath?: string;
+  /**
+   * Lifetime of the download URLs in seconds, at most seven days, the
+   * SigV4 limit. @default 3600
+   */
+  signedUrlExpiresIn?: number;
+}
+/**
+ * Bundles in a Neon Object Storage bucket, through its S3 API. Devices
+ * download from presigned URLs that expire, so a private bucket works.
+ */
+declare const neonStorage: (config: NeonStorageConfig) => StorageAdapterWith<S3StorageOperations>;
+//#endregion
+export { NeonStorageConfig, type PostgresConfig, neonStorage, postgres };

package/dist/index.d.mts

@@ -0,0 +1,33 @@
+import { S3ClientConfig, S3StorageOperations } from "@hot-updater/storage-s3";
+import { PostgresConfig, postgres } from "@hot-updater/postgres";
+import { StorageAdapterWith } from "@hot-updater/plugin-core";
+//#region src/neonStorage.d.ts
+interface NeonStorageConfig extends Omit<S3ClientConfig, "credentials" | "endpoint" | "forcePathStyle"> {
+  /**
+   * The branch's object storage endpoint, such as
+   * `https://br-xxx.storage.c-5.us-east-2.aws.neon.tech`: the
+   * `AWS_ENDPOINT_URL_S3` that `neon env pull` writes.
+   */
+  endpoint: string;
+  /** The bucket on that branch. */
+  bucketName: string;
+  /**
+   * A storage credential of the project: the `AWS_ACCESS_KEY_ID` and
+   * `AWS_SECRET_ACCESS_KEY` that `neon env pull` writes.
+   */
+  credentials: NonNullable<S3ClientConfig["credentials"]>;
+  /** Base path where bundles will be stored in the bucket. */
+  basePath?: string;
+  /**
+   * Lifetime of the download URLs in seconds, at most seven days, the
+   * SigV4 limit. @default 3600
+   */
+  signedUrlExpiresIn?: number;
+}
+/**
+ * Bundles in a Neon Object Storage bucket, through its S3 API. Devices
+ * download from presigned URLs that expire, so a private bucket works.
+ */
+declare const neonStorage: (config: NeonStorageConfig) => StorageAdapterWith<S3StorageOperations>;
+//#endregion
+export { NeonStorageConfig, type PostgresConfig, neonStorage, postgres };

package/dist/index.mjs

@@ -0,0 +1,32 @@
+import { createS3Storage } from "@hot-updater/storage-s3";
+import { postgres } from "@hot-updater/postgres";
+//#region src/neonStorage.ts
+/** The endpoint's origin, or an error that names the variable to set. */
+const endpointOrigin = (endpoint) => {
+	let url;
+	try {
+		url = new URL(endpoint);
+	} catch {
+		throw new Error("neonStorage needs the branch's storage endpoint (AWS_ENDPOINT_URL_S3), such as https://br-xxx.storage.c-5.us-east-2.aws.neon.tech.");
+	}
+	if (url.pathname !== "/" && url.pathname !== "") throw new Error(`neonStorage endpoint must not include a path: pass the bucket as bucketName instead of "${url.pathname}".`);
+	return url.origin;
+};
+/**
+* Bundles in a Neon Object Storage bucket, through its S3 API. Devices
+* download from presigned URLs that expire, so a private bucket works.
+*/
+const neonStorage = (config) => {
+	const { endpoint, region, ...s3Config } = config;
+	return createS3Storage({
+		name: "neonStorage",
+		protocol: "neon"
+	}, {
+		...s3Config,
+		endpoint: endpointOrigin(endpoint),
+		forcePathStyle: true,
+		region: region ?? "us-east-1"
+	});
+};
+//#endregion
+export { neonStorage, postgres };

package/package.json

@@ -1,6 +1,50 @@
 {
   "name": "@hot-updater/neon",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "type": "module",
+  "version": "1.1.5",
+  "description": "React Native OTA solution for self-hosted",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gronxb/hot-updater"
+  },
+  "author": "gronxb <gron1gh1@gmail.com> (https://github.com/gronxb)",
+  "bugs": {
+    "url": "https://github.com/gronxb/hot-updater/issues"
+  },
+  "homepage": "https://github.com/gronxb/hot-updater#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "!**/*.spec.ts",
+    "package.json"
+  ],
+  "dependencies": {
+    "@hot-updater/plugin-core": "1.1.5",
+    "@hot-updater/postgres": "1.1.5",
+    "@hot-updater/storage-s3": "1.1.5"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-s3": "3.1066.0",
+    "@aws-sdk/lib-storage": "3.1066.0",
+    "@types/node": "^20",
+    "vitest": "4.1.4",
+    "@hot-updater/test-utils": "1.1.5"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test:type": "tsc --noEmit"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-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.