@relevate/poolster-plugin-faker 0.0.0-stage → 0.5.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Relevate
+
+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.

package/README.md

@@ -1,3 +1,22 @@
-# Temporary Holding Version
+# @relevate/poolster-plugin-faker
 
-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.
+Select Poolster's compiled Rust faker plugin from a JavaScript config. Install
+with `@relevate/poolster` and `@relevate/poolster-plugin-typescript`, then
+list both factories in `plugins`. Nothing is registered automatically.
+
+```js
+import { defineConfig } from '@relevate/poolster'
+import { pluginTypeScript } from '@relevate/poolster-plugin-typescript'
+import { pluginFaker } from '@relevate/poolster-plugin-faker'
+
+export default defineConfig({
+  input: './openapi.yaml',
+  output: './generated',
+  name: 'Example',
+  version: '1.0.0',
+  plugins: [pluginTypeScript(), pluginFaker({ target: 'typescript' })],
+})
+```
+
+The `target` names the TypeScript SDK package path; use it when the package
+path differs from the default or multiple TypeScript packages are selected.

package/index.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+function pluginFaker(options = {}) {
+  if (!options || typeof options !== 'object' || Array.isArray(options)) throw new TypeError('pluginFaker options must be an object');
+  for (const key of Object.keys(options)) if (key !== 'target' && key !== 'output') throw new TypeError('unknown pluginFaker option ' + key);
+  if (options.target != null && (typeof options.target !== 'string' || !options.target)) throw new TypeError('target must be a nonempty string');
+  if (options.output != null && (typeof options.output !== 'string' || !options.output)) throw new TypeError('output must be a nonempty string');
+  return { kind: 'native-addon', name: '@relevate/poolster-plugin-faker', plugin: 'faker', target: options.target ?? 'typescript', ...(options.output ? { output: options.output } : {}) };
+}
+
+module.exports = { pluginFaker };

package/index.d.ts

@@ -0,0 +1,4 @@
+import type { NativeAddon } from '@relevate/poolster';
+
+export interface FakerPluginOptions { target?: string; output?: string }
+export function pluginFaker(options?: FakerPluginOptions): NativeAddon;

package/index.mjs

@@ -0,0 +1,3 @@
+import api from './index.cjs';
+
+export const pluginFaker = api.pluginFaker;

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@relevate/poolster-plugin-faker",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.5.0-alpha.1",
+  "description": "Poolster plugin exports for faker",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rlvtapp/poolster.git"
+  },
+  "main": "index.cjs",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./index.cjs"
+    }
+  },
+  "files": [
+    "index.cjs",
+    "index.mjs",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "@relevate/poolster": "0.5.0-alpha.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}