@pigeonposse/api-2026 0.0.0-stage → 1.0.2

package/README.md

@@ -1,3 +1,121 @@
-# Temporary Holding Version
+# PIGEONPOSSE API
 
-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.
+![HEADER](https://raw.githubusercontent.com/pigeonposse/pigeon-web/main/docs/public/banner.png)
+
+Run the PigeonPosse API.
+
+Rest API to get data from your GitHub repository.
+
+- Required for [@pigeonposse/web-2026](https://www.npmjs.com/package/@pigeonposse/web-2026)
+
+## Prerequisites
+
+- GitHub Token [Read more](https://github.com/settings/tokens)
+
+## Installation
+
+```bash
+npm i @pigeonposse/api-2026
+# or
+pnpm i @pigeonposse/api-2026
+```
+
+## CLI Usage
+
+```bash
+GH_TOKEN="your-github-token" GH_USER="your-github-user" npx @pigeonposse/api-2026
+# or
+GH_TOKEN="your-github-token" GH_USER="your-github-user" pnpx @pigeonposse/api-2026
+```
+
+Or with a installation
+
+```bash
+npm i @pigeonposse/api-2026
+GH_TOKEN="your-github-token" npm exec pigeonposse-api-2026
+# or
+pnpm i @pigeonposse/api-2026
+GH_TOKEN="your-github-token" GH_USER="your-github-user" pnpm exec pigeonposse-api-2026
+```
+
+## Library Usage
+
+### Standard server
+
+```js
+import { createServer } from '@pigeonposse/api-2026' // OR: import { createServer } from '@pigeonposse/api-2026/server'
+createServer( {
+ DEBUG: 'false',
+ GH_TOKEN: "your-github-token",
+ GH_USER: 'angelespejo',
+ GH_BRANCH: 'main',
+ GH_USER_TYPE: 'user',
+ API_PORT: 1312,
+ API_STORE_PATH: 'build/store/pigeonposse.json'
+} )
+```
+
+```bash
+node standard-server.js
+## Override OPTION
+DEBUG=true node standard-server.js
+```
+
+### Local server
+
+```js
+import { createLocalServer } from '@pigeonposse/api-2026' // OR: import { createLocalServer } from '@pigeonposse/api-2026/server'
+
+createLocalServer( {
+ DEBUG: 'false',
+ GH_TOKEN: "your-github-token",
+ GH_USER: 'angelespejo',
+ GH_BRANCH: 'main',
+ GH_USER_TYPE: 'user',
+ API_PORT: 1312,
+ API_STORE_PATH: 'build/store/pigeonposse.json'
+} )
+```
+
+```bash
+node local-server.js
+## Override OPTION
+DEBUG=true node local-server.js
+```
+
+### Custom server
+
+You can use only the app, for build your server wetheaver you want.
+
+### Standard app
+
+```js
+import { appStandard } from '@pigeonposse/api-2026' // OR: import app from '@pigeonposse/api-2026/standard'
+
+// Build you server
+```
+
+### Local app
+
+```js
+import { appLocal } from '@pigeonposse/api-2026' // OR: import app from '@pigeonposse/api-2026/local'
+
+// Build you server
+```
+
+### Change enviroment variables
+
+```js
+import { ENV } from '@pigeonposse/api-2026' // OR: import { ENV } from '@pigeonposse/api-2026/env'
+
+ENV.DEBUG = 'true'
+ENV.GH_USER='angelespejo'
+ENV.GH_BRANCH='main'
+ENV.GH_USER_TYPE='user'
+
+// Do something
+```
+
+## Add custom config in your repositories
+
+This package use Collectium Github Preset for get Github data. For more information read [Docs](https://collectium.pigeonposse.com/guide/preset/github/)

package/dist/bin.cjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+'use strict';
+
+const server = require('./shared/api-2026.DKKpCkQB.cjs');
+require('@backan/server');
+require('./env.cjs');
+require('@pigeonposse/api-config-2026');
+require('./shared/api-2026.C367WW-0.cjs');
+require('@collectium/api/local');
+require('@collectium/core');
+require('node:util');
+require('@collectium/api/standard');
+
+server.createLocalServer();

package/dist/bin.d.cts

@@ -0,0 +1 @@
+

package/dist/bin.d.mts

@@ -0,0 +1 @@
+

package/dist/bin.d.ts

@@ -0,0 +1 @@
+

package/dist/bin.mjs

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import { c as createLocalServer } from './shared/api-2026.CrRWS0qQ.mjs';
+import '@backan/server';
+import './env.mjs';
+import '@pigeonposse/api-config-2026';
+import './shared/api-2026.CDiWYIa6.mjs';
+import '@collectium/api/local';
+import '@collectium/core';
+import 'node:util';
+import '@collectium/api/standard';
+
+createLocalServer();

package/dist/env.cjs

@@ -0,0 +1,21 @@
+'use strict';
+
+const config = require('@pigeonposse/api-config-2026');
+
+const ENV = {
+  ...config.ENV,
+  /**
+   * Used in server.
+   *
+   * @default 1312
+   */
+  API_PORT: Number(globalThis.process.env.API_PORT) || 1312,
+  /**
+   * Used in server.
+   *
+   * @default 'build/store/pigeonposse-api.json'
+   */
+  API_STORE_PATH: globalThis.process.env.API_STORE_PATH || "build/store/pigeonposse-api.json"
+};
+
+exports.ENV = ENV;

package/dist/env.d.cts

@@ -0,0 +1,23 @@
+type Env = typeof ENV;
+declare const ENV: {
+    /**
+     * Used in server.
+     *
+     * @default 1312
+     */
+    API_PORT: number;
+    /**
+     * Used in server.
+     *
+     * @default 'build/store/pigeonposse-api.json'
+     */
+    API_STORE_PATH: string;
+    DEBUG: "true" | "false" | undefined;
+    GH_TOKEN: string | undefined;
+    GH_USER: string;
+    GH_BRANCH: string;
+    GH_USER_TYPE: "org" | "user" | undefined;
+};
+
+export { ENV };
+export type { Env };

package/dist/env.d.mts

@@ -0,0 +1,23 @@
+type Env = typeof ENV;
+declare const ENV: {
+    /**
+     * Used in server.
+     *
+     * @default 1312
+     */
+    API_PORT: number;
+    /**
+     * Used in server.
+     *
+     * @default 'build/store/pigeonposse-api.json'
+     */
+    API_STORE_PATH: string;
+    DEBUG: "true" | "false" | undefined;
+    GH_TOKEN: string | undefined;
+    GH_USER: string;
+    GH_BRANCH: string;
+    GH_USER_TYPE: "org" | "user" | undefined;
+};
+
+export { ENV };
+export type { Env };

package/dist/env.d.ts

@@ -0,0 +1,23 @@
+type Env = typeof ENV;
+declare const ENV: {
+    /**
+     * Used in server.
+     *
+     * @default 1312
+     */
+    API_PORT: number;
+    /**
+     * Used in server.
+     *
+     * @default 'build/store/pigeonposse-api.json'
+     */
+    API_STORE_PATH: string;
+    DEBUG: "true" | "false" | undefined;
+    GH_TOKEN: string | undefined;
+    GH_USER: string;
+    GH_BRANCH: string;
+    GH_USER_TYPE: "org" | "user" | undefined;
+};
+
+export { ENV };
+export type { Env };

package/dist/env.mjs

@@ -0,0 +1,19 @@
+import { ENV as ENV$1 } from '@pigeonposse/api-config-2026';
+
+const ENV = {
+  ...ENV$1,
+  /**
+   * Used in server.
+   *
+   * @default 1312
+   */
+  API_PORT: Number(globalThis.process.env.API_PORT) || 1312,
+  /**
+   * Used in server.
+   *
+   * @default 'build/store/pigeonposse-api.json'
+   */
+  API_STORE_PATH: globalThis.process.env.API_STORE_PATH || "build/store/pigeonposse-api.json"
+};
+
+export { ENV };

package/dist/local.cjs

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+require('@collectium/api/local');
+require('./env.cjs');
+const local = require('./shared/api-2026.C367WW-0.cjs');
+require('@pigeonposse/api-config-2026');
+require('@collectium/core');
+require('node:util');
+
+
+
+exports.appLocal = local.appLocal;
+exports.default = local.appLocal;

package/dist/local.d.cts

@@ -0,0 +1,9 @@
+import createApp from '@collectium/api/local';
+
+type AppLocalRes = ReturnType<typeof createApp>;
+declare const appLocal: () => AppLocalRes;
+
+// @ts-ignore
+export = appLocal;
+export { appLocal };
+export type { AppLocalRes };

package/dist/local.d.mts

@@ -0,0 +1,7 @@
+import createApp from '@collectium/api/local';
+
+type AppLocalRes = ReturnType<typeof createApp>;
+declare const appLocal: () => AppLocalRes;
+
+export { appLocal, appLocal as default };
+export type { AppLocalRes };

package/dist/local.d.ts

@@ -0,0 +1,9 @@
+import createApp from '@collectium/api/local';
+
+type AppLocalRes = ReturnType<typeof createApp>;
+declare const appLocal: () => AppLocalRes;
+
+// @ts-ignore
+export = appLocal;
+export { appLocal };
+export type { AppLocalRes };

package/dist/local.mjs

@@ -0,0 +1,6 @@
+import '@collectium/api/local';
+import './env.mjs';
+export { a as appLocal, a as default } from './shared/api-2026.CDiWYIa6.mjs';
+import '@pigeonposse/api-config-2026';
+import '@collectium/core';
+import 'node:util';

package/dist/main.cjs

@@ -0,0 +1,22 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const env = require('./env.cjs');
+const local = require('./shared/api-2026.C367WW-0.cjs');
+const server = require('./shared/api-2026.DKKpCkQB.cjs');
+require('@pigeonposse/api-config-2026');
+require('@collectium/api/local');
+require('@collectium/core');
+require('node:util');
+require('@backan/server');
+require('@collectium/api/standard');
+
+
+
+exports.ENV = env.ENV;
+exports.appLocal = local.appLocal;
+exports.appStandard = server.appStandard;
+exports.createLocalServer = server.createLocalServer;
+exports.createServer = server.createServer;
+exports.default = server.appStandard;

package/dist/main.d.cts

@@ -0,0 +1,13 @@
+export { ENV, Env } from './env.cjs';
+export { AppLocalRes, appLocal } from './local.cjs';
+import createApp from '@collectium/api/standard';
+export { CreateLocalServerProps, CreateServerProps, createLocalServer, createServer } from './server.cjs';
+import '@collectium/api/local';
+
+type AppStandardRes = ReturnType<typeof createApp>;
+declare const appStandard: () => AppStandardRes;
+
+// @ts-ignore
+export = appStandard;
+export { appStandard };
+export type { AppStandardRes };

package/dist/main.d.mts

@@ -0,0 +1,11 @@
+export { ENV, Env } from './env.mjs';
+export { AppLocalRes, appLocal } from './local.mjs';
+import createApp from '@collectium/api/standard';
+export { CreateLocalServerProps, CreateServerProps, createLocalServer, createServer } from './server.mjs';
+import '@collectium/api/local';
+
+type AppStandardRes = ReturnType<typeof createApp>;
+declare const appStandard: () => AppStandardRes;
+
+export { appStandard, appStandard as default };
+export type { AppStandardRes };

package/dist/main.d.ts

@@ -0,0 +1,13 @@
+export { ENV, Env } from './env.js';
+export { AppLocalRes, appLocal } from './local.js';
+import createApp from '@collectium/api/standard';
+export { CreateLocalServerProps, CreateServerProps, createLocalServer, createServer } from './server.js';
+import '@collectium/api/local';
+
+type AppStandardRes = ReturnType<typeof createApp>;
+declare const appStandard: () => AppStandardRes;
+
+// @ts-ignore
+export = appStandard;
+export { appStandard };
+export type { AppStandardRes };

package/dist/main.mjs

@@ -0,0 +1,14 @@
+export { ENV } from './env.mjs';
+export { a as appLocal } from './shared/api-2026.CDiWYIa6.mjs';
+import { a as appStandard } from './shared/api-2026.CrRWS0qQ.mjs';
+export { c as createLocalServer, b as createServer } from './shared/api-2026.CrRWS0qQ.mjs';
+import '@pigeonposse/api-config-2026';
+import '@collectium/api/local';
+import '@collectium/core';
+import 'node:util';
+import '@backan/server';
+import '@collectium/api/standard';
+
+
+
+export { appStandard, appStandard as default };

package/dist/schema/banner.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/code-of-conduct.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/composer.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/config.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/contributting.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/logo.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/package.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/readme.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/security.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schema/support.json

@@ -0,0 +1,4 @@
+{
+	"type": "string",
+	"$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/server.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+require('@backan/server');
+require('./env.cjs');
+require('./shared/api-2026.C367WW-0.cjs');
+const server = require('./shared/api-2026.DKKpCkQB.cjs');
+require('@pigeonposse/api-config-2026');
+require('@collectium/api/local');
+require('@collectium/core');
+require('node:util');
+require('@collectium/api/standard');
+
+
+
+exports.createLocalServer = server.createLocalServer;
+exports.createServer = server.createServer;

package/dist/server.d.cts

@@ -0,0 +1,9 @@
+import { Env } from './env.cjs';
+
+type CreateLocalServerProps = Partial<Env>;
+type CreateServerProps = Omit<Partial<Env>, 'API_STORE_PATH'>;
+declare const createServer: (props?: CreateServerProps) => Promise<void>;
+declare const createLocalServer: (props?: CreateLocalServerProps) => Promise<void>;
+
+export { createLocalServer, createServer };
+export type { CreateLocalServerProps, CreateServerProps };

package/dist/server.d.mts

@@ -0,0 +1,9 @@
+import { Env } from './env.mjs';
+
+type CreateLocalServerProps = Partial<Env>;
+type CreateServerProps = Omit<Partial<Env>, 'API_STORE_PATH'>;
+declare const createServer: (props?: CreateServerProps) => Promise<void>;
+declare const createLocalServer: (props?: CreateLocalServerProps) => Promise<void>;
+
+export { createLocalServer, createServer };
+export type { CreateLocalServerProps, CreateServerProps };

package/dist/server.d.ts

@@ -0,0 +1,9 @@
+import { Env } from './env.js';
+
+type CreateLocalServerProps = Partial<Env>;
+type CreateServerProps = Omit<Partial<Env>, 'API_STORE_PATH'>;
+declare const createServer: (props?: CreateServerProps) => Promise<void>;
+declare const createLocalServer: (props?: CreateLocalServerProps) => Promise<void>;
+
+export { createLocalServer, createServer };
+export type { CreateLocalServerProps, CreateServerProps };

package/dist/server.mjs

@@ -0,0 +1,9 @@
+import '@backan/server';
+import './env.mjs';
+import './shared/api-2026.CDiWYIa6.mjs';
+export { c as createLocalServer, b as createServer } from './shared/api-2026.CrRWS0qQ.mjs';
+import '@pigeonposse/api-config-2026';
+import '@collectium/api/local';
+import '@collectium/core';
+import 'node:util';
+import '@collectium/api/standard';

package/dist/shared/api-2026.C367WW-0.cjs

@@ -0,0 +1,34 @@
+'use strict';
+
+const createApp = require('@collectium/api/local');
+const env = require('../env.cjs');
+const core = require('@collectium/core');
+const config = require('@pigeonposse/api-config-2026');
+const node_util = require('node:util');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const createApp__default = /*#__PURE__*/_interopDefaultCompat(createApp);
+const config__default = /*#__PURE__*/_interopDefaultCompat(config);
+
+const collectium = new core.Collectium(config__default);
+
+const bold = (v) => node_util.styleText("bold", v);
+const desc = (v) => node_util.styleText("dim", v);
+const warnOut = (v) => node_util.styleText("yellow", `${bold("\u26A0 IMPORTANT")} ${desc(v)}`);
+const setNotifications = () => {
+  if (!env.ENV.GH_TOKEN)
+    console.warn(warnOut("Pass a Github token as an argument for the API to work fully\n"));
+};
+
+const appLocal = () => {
+  setNotifications();
+  return createApp__default({
+    collectium,
+    opts: { path: env.ENV.API_STORE_PATH }
+  });
+};
+
+exports.appLocal = appLocal;
+exports.collectium = collectium;
+exports.setNotifications = setNotifications;

package/dist/shared/api-2026.CDiWYIa6.mjs

@@ -0,0 +1,25 @@
+import createApp from '@collectium/api/local';
+import { ENV } from '../env.mjs';
+import { Collectium } from '@collectium/core';
+import config from '@pigeonposse/api-config-2026';
+import { styleText } from 'node:util';
+
+const collectium = new Collectium(config);
+
+const bold = (v) => styleText("bold", v);
+const desc = (v) => styleText("dim", v);
+const warnOut = (v) => styleText("yellow", `${bold("\u26A0 IMPORTANT")} ${desc(v)}`);
+const setNotifications = () => {
+  if (!ENV.GH_TOKEN)
+    console.warn(warnOut("Pass a Github token as an argument for the API to work fully\n"));
+};
+
+const appLocal = () => {
+  setNotifications();
+  return createApp({
+    collectium,
+    opts: { path: ENV.API_STORE_PATH }
+  });
+};
+
+export { appLocal as a, collectium as c, setNotifications as s };

package/dist/shared/api-2026.CrRWS0qQ.mjs

@@ -0,0 +1,32 @@
+import { server } from '@backan/server';
+import { ENV } from '../env.mjs';
+import { s as setNotifications, c as collectium, a as appLocal } from './api-2026.CDiWYIa6.mjs';
+import createApp from '@collectium/api/standard';
+
+const appStandard = () => {
+  setNotifications();
+  return createApp({ collectium });
+};
+
+const createServer = async (props) => {
+  if (props) Object.entries(props).forEach(([key, value]) => {
+    if (key in ENV) ENV[key] = value;
+  });
+  if (ENV.DEBUG === "true") console.log({ ENV });
+  await server({
+    app: appStandard(),
+    port: ENV.API_PORT
+  });
+};
+const createLocalServer = async (props) => {
+  if (props) Object.entries(props).forEach(([key, value]) => {
+    if (key in ENV) ENV[key] = value;
+  });
+  if (ENV.DEBUG === "true") console.log({ ENV });
+  await server({
+    app: appLocal(),
+    port: ENV.API_PORT
+  });
+};
+
+export { appStandard as a, createServer as b, createLocalServer as c };