@riloservices/base 0.0.0-stage → 0.1.1

package/dist/mongoose.cjs

@@ -0,0 +1,21 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_key = require("./key-DPXUxbGX.cjs");
+// src/mongoose.ts
+/**
+* Connects Mongoose to one database of your Space with your app key, or with a `rilodb://` link.
+* It makes the same link as `createClient`, and adds the Space's id to the database name. Throws a
+* `RiloKeyError` for input that is missing or is neither, and a `TypeError` when no database is
+* named by `database` or by the link.
+*/
+async function connectMongoose(mongoose, keyOrLink, options) {
+	const { database, appName, ...addresses } = options;
+	const target = require_key.resolveTarget(keyOrLink, addresses);
+	const name = database ?? target.database ?? void 0;
+	if (name === void 0 || name === "") throw new TypeError("Say which database to open: give connectMongoose a `database` option, or a rilodb:// link that names one.");
+	return mongoose.connect(target.connectLink, {
+		dbName: `${name}_${target.spaceId}`,
+		...appName === void 0 ? {} : { appName }
+	});
+}
+exports.RiloKeyError = require_key.RiloKeyError;
+exports.connectMongoose = connectMongoose;

package/dist/mongoose.d.cts

@@ -0,0 +1,29 @@
+import { t as AddressOptions } from "./types-CD9NBWdA.cjs";
+import { n as RiloKeyError } from "./errors-DwVg5fNj.cjs";
+/**
+ * The part of your Mongoose instance that this uses. Mongoose isn't a dependency of this package:
+ * pass the one your app already has.
+ */
+export interface MongooseLike<Connected = unknown> {
+  connect(uri: string, options: {
+    dbName: string;
+    appName?: string;
+  }): Promise<Connected>;
+}
+export interface ConnectMongooseOptions extends Omit<AddressOptions, 'filesUrl'> {
+  /**
+   * The database to open, by the name you gave it, like `salon-prod`. Needed with an app key. A
+   * `rilodb://` link that names a database makes this optional.
+   */
+  database?: string;
+  /** Shown in the Gateway's connection details, to tell apps apart. */
+  appName?: string;
+}
+/**
+ * Connects Mongoose to one database of your Space with your app key, or with a `rilodb://` link.
+ * It makes the same link as `createClient`, and adds the Space's id to the database name. Throws a
+ * `RiloKeyError` for input that is missing or is neither, and a `TypeError` when no database is
+ * named by `database` or by the link.
+ */
+export declare function connectMongoose<Connected>(mongoose: MongooseLike<Connected>, keyOrLink: string | null | undefined, options: ConnectMongooseOptions): Promise<Connected>;
+export { RiloKeyError };

package/dist/mongoose.d.mts

@@ -0,0 +1,29 @@
+import { t as AddressOptions } from "./types-CD9NBWdA.mjs";
+import { n as RiloKeyError } from "./errors-DwVg5fNj.mjs";
+/**
+ * The part of your Mongoose instance that this uses. Mongoose isn't a dependency of this package:
+ * pass the one your app already has.
+ */
+export interface MongooseLike<Connected = unknown> {
+  connect(uri: string, options: {
+    dbName: string;
+    appName?: string;
+  }): Promise<Connected>;
+}
+export interface ConnectMongooseOptions extends Omit<AddressOptions, 'filesUrl'> {
+  /**
+   * The database to open, by the name you gave it, like `salon-prod`. Needed with an app key. A
+   * `rilodb://` link that names a database makes this optional.
+   */
+  database?: string;
+  /** Shown in the Gateway's connection details, to tell apps apart. */
+  appName?: string;
+}
+/**
+ * Connects Mongoose to one database of your Space with your app key, or with a `rilodb://` link.
+ * It makes the same link as `createClient`, and adds the Space's id to the database name. Throws a
+ * `RiloKeyError` for input that is missing or is neither, and a `TypeError` when no database is
+ * named by `database` or by the link.
+ */
+export declare function connectMongoose<Connected>(mongoose: MongooseLike<Connected>, keyOrLink: string | null | undefined, options: ConnectMongooseOptions): Promise<Connected>;
+export { RiloKeyError };

package/dist/mongoose.mjs

@@ -0,0 +1,19 @@
+import { r as RiloKeyError, t as resolveTarget } from "./key-B7koHuaE.mjs";
+// src/mongoose.ts
+/**
+* Connects Mongoose to one database of your Space with your app key, or with a `rilodb://` link.
+* It makes the same link as `createClient`, and adds the Space's id to the database name. Throws a
+* `RiloKeyError` for input that is missing or is neither, and a `TypeError` when no database is
+* named by `database` or by the link.
+*/
+async function connectMongoose(mongoose, keyOrLink, options) {
+	const { database, appName, ...addresses } = options;
+	const target = resolveTarget(keyOrLink, addresses);
+	const name = database ?? target.database ?? void 0;
+	if (name === void 0 || name === "") throw new TypeError("Say which database to open: give connectMongoose a `database` option, or a rilodb:// link that names one.");
+	return mongoose.connect(target.connectLink, {
+		dbName: `${name}_${target.spaceId}`,
+		...appName === void 0 ? {} : { appName }
+	});
+}
+export { RiloKeyError, connectMongoose };

package/dist/types-CD9NBWdA.d.cts

@@ -0,0 +1,88 @@
+/** `POST /v1/buckets/:bucket/uploads` */
+interface UploadBody {
+  /** Where the file goes inside the bucket, folders included, like `avatars/user-42.jpg`. */
+  path: string;
+  contentType: string;
+  /** Bytes. The upload must be exactly this size. */
+  size: number;
+}
+/** A signed form post to storage: send `fields`, then the file as the last field, named `file`. */
+interface UploadTicket {
+  url: string;
+  fields: Record<string, string>;
+  expiresAt: string;
+  path: string;
+  /** Names the upload. `cancelUpload` releases its hold on storage at once. */
+  uploadId: string;
+  /** The permanent link, for a public bucket only. */
+  publicUrl?: string;
+}
+/** What `link` and `links` can set. */
+interface LinkOptions {
+  /** Private buckets only: from 1 second to 7 days. The default is one hour. */
+  expiresInSeconds?: number;
+}
+/** A link to one file. A public bucket's links are permanent, so `expiresAt` is null. */
+interface FileLink {
+  path: string;
+  url: string;
+  expiresAt: string | null;
+}
+/** A file in a list. */
+interface FileEntry {
+  path: string;
+  size: number;
+  updatedAt: string;
+  /** Null when the list has no record of the type; `get` always has it. */
+  contentType: string | null;
+}
+/** One file, from `get`. */
+interface FileInfo extends FileEntry {
+  contentType: string;
+}
+/** What `list` takes. */
+interface ListFilesQuery {
+  /** Only paths that start with this text. Add a closing slash to name a folder. */
+  prefix?: string;
+  /** `/` to list one folder level at a time. Leave it out for a flat list. */
+  delimiter?: '/';
+  /** The `nextCursor` of the previous page. */
+  cursor?: string;
+  /** From 1 to 1,000 files and folders in a page. The default is 100. */
+  limit?: number;
+}
+/** One page of files and folders. */
+interface FileList {
+  files: FileEntry[];
+  /** With `delimiter: '/'`: the folders directly under `prefix`, each ending in a slash. */
+  folders: string[];
+  /** Pass it back as `cursor` for the next page; null on the last. */
+  nextCursor: string | null;
+}
+interface FilesBucketView {
+  name: string;
+  visibility: 'public' | 'private';
+  maxFileSize: number;
+  allowedTypes: string[];
+}
+/** What `buckets` answers. */
+interface FilesBuckets {
+  buckets: FilesBucketView[];
+  usage: {
+    /** Bytes counted against the storage limit. */
+    totalBytes: number;
+    limitBytes: number;
+  };
+}
+/** Where a Space is reached. Production needs none of them; they are for local stand-ins. */
+interface AddressOptions {
+  /** The domain Spaces live under. Default: `db.services.rilo.studio`. */
+  spacesDomain?: string;
+  /** The Gateway's port. Default: 27017. */
+  port?: number;
+  /** A CA file to trust, for a local stand-in with its own certificate. */
+  tlsCAFile?: string;
+  /** The Files API address. Default: `https://files.<region>.<spacesDomain>`. */
+  filesUrl?: string;
+}
+export { FileList as a, LinkOptions as c, UploadTicket as d, FileLink as i, ListFilesQuery as l, FileEntry as n, FilesBucketView as o, FileInfo as r, FilesBuckets as s, AddressOptions as t, UploadBody as u };

package/dist/types-CD9NBWdA.d.mts

@@ -0,0 +1,88 @@
+/** `POST /v1/buckets/:bucket/uploads` */
+interface UploadBody {
+  /** Where the file goes inside the bucket, folders included, like `avatars/user-42.jpg`. */
+  path: string;
+  contentType: string;
+  /** Bytes. The upload must be exactly this size. */
+  size: number;
+}
+/** A signed form post to storage: send `fields`, then the file as the last field, named `file`. */
+interface UploadTicket {
+  url: string;
+  fields: Record<string, string>;
+  expiresAt: string;
+  path: string;
+  /** Names the upload. `cancelUpload` releases its hold on storage at once. */
+  uploadId: string;
+  /** The permanent link, for a public bucket only. */
+  publicUrl?: string;
+}
+/** What `link` and `links` can set. */
+interface LinkOptions {
+  /** Private buckets only: from 1 second to 7 days. The default is one hour. */
+  expiresInSeconds?: number;
+}
+/** A link to one file. A public bucket's links are permanent, so `expiresAt` is null. */
+interface FileLink {
+  path: string;
+  url: string;
+  expiresAt: string | null;
+}
+/** A file in a list. */
+interface FileEntry {
+  path: string;
+  size: number;
+  updatedAt: string;
+  /** Null when the list has no record of the type; `get` always has it. */
+  contentType: string | null;
+}
+/** One file, from `get`. */
+interface FileInfo extends FileEntry {
+  contentType: string;
+}
+/** What `list` takes. */
+interface ListFilesQuery {
+  /** Only paths that start with this text. Add a closing slash to name a folder. */
+  prefix?: string;
+  /** `/` to list one folder level at a time. Leave it out for a flat list. */
+  delimiter?: '/';
+  /** The `nextCursor` of the previous page. */
+  cursor?: string;
+  /** From 1 to 1,000 files and folders in a page. The default is 100. */
+  limit?: number;
+}
+/** One page of files and folders. */
+interface FileList {
+  files: FileEntry[];
+  /** With `delimiter: '/'`: the folders directly under `prefix`, each ending in a slash. */
+  folders: string[];
+  /** Pass it back as `cursor` for the next page; null on the last. */
+  nextCursor: string | null;
+}
+interface FilesBucketView {
+  name: string;
+  visibility: 'public' | 'private';
+  maxFileSize: number;
+  allowedTypes: string[];
+}
+/** What `buckets` answers. */
+interface FilesBuckets {
+  buckets: FilesBucketView[];
+  usage: {
+    /** Bytes counted against the storage limit. */
+    totalBytes: number;
+    limitBytes: number;
+  };
+}
+/** Where a Space is reached. Production needs none of them; they are for local stand-ins. */
+interface AddressOptions {
+  /** The domain Spaces live under. Default: `db.services.rilo.studio`. */
+  spacesDomain?: string;
+  /** The Gateway's port. Default: 27017. */
+  port?: number;
+  /** A CA file to trust, for a local stand-in with its own certificate. */
+  tlsCAFile?: string;
+  /** The Files API address. Default: `https://files.<region>.<spacesDomain>`. */
+  filesUrl?: string;
+}
+export { FileList as a, LinkOptions as c, UploadTicket as d, FileLink as i, ListFilesQuery as l, FileEntry as n, FilesBucketView as o, FileInfo as r, FilesBuckets as s, AddressOptions as t, UploadBody as u };

package/package.json

@@ -1,6 +1,74 @@
 {
   "name": "@riloservices/base",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Use a Rilo DB Space from your server with one app key: your databases through the MongoDB driver, and Files.",
+  "license": "MIT",
+  "homepage": "https://db.services.rilo.studio/docs",
+  "keywords": [
+    "rilo",
+    "rilo-db",
+    "database",
+    "mongodb",
+    "mongoose",
+    "files",
+    "file-upload",
+    "storage",
+    "client",
+    "app-key"
+  ],
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./mongoose": {
+      "import": {
+        "types": "./dist/mongoose.d.mts",
+        "default": "./dist/mongoose.mjs"
+      },
+      "require": {
+        "types": "./dist/mongoose.d.cts",
+        "default": "./dist/mongoose.cjs"
+      }
+    },
+    "./browser": {
+      "import": {
+        "types": "./dist/browser.d.mts",
+        "default": "./dist/browser.mjs"
+      },
+      "require": {
+        "types": "./dist/browser.d.cts",
+        "default": "./dist/browser.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "bin": {
+    "rilo-db": "dist/cli.mjs"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20.19"
+  },
+  "peerDependencies": {
+    "mongodb": "^6.10.0 || ^7.0.0"
+  }
+}