@blimu/types 0.1.0

package/README.md

@@ -0,0 +1,51 @@
+# @blimu/types
+
+TypeScript type definitions for Blimu simple types.
+
+## Overview
+
+This package provides base type definitions for Blimu's simple types (ResourceType, EntitlementType, PlanType, etc.). These types are augmented by customer configuration via the `blimu codegen` command, which generates union types based on your Blimu configuration.
+
+## Installation
+
+```bash
+npm install @blimu/types
+# or
+yarn add @blimu/types
+# or
+pnpm add @blimu/types
+```
+
+## Usage
+
+After running `blimu codegen` in your project, the types in this package will be augmented with union types based on your configuration:
+
+```typescript
+import type { ResourceType, EntitlementType } from '@blimu/types';
+
+// After codegen, ResourceType might be:
+// type ResourceType = 'organization' | 'workspace' | 'project';
+
+// EntitlementType might be:
+// type EntitlementType = 'organization:create_workspace' | 'workspace:delete';
+```
+
+## Types
+
+- **ResourceType**: Resource type identifiers
+- **EntitlementType**: Entitlement type identifiers
+- **PlanType**: Plan type identifiers
+- **LimitType**: Resource-based limit type identifiers
+- **UsageLimitType**: Usage-based limit type identifiers
+
+## Type Augmentation
+
+To augment these types with your configuration:
+
+1. Create a Blimu config file (`.blimu/config.mjs` or `.blimu/config.ts`)
+2. Run `blimu codegen`
+3. The generated `.blimu/blimu-types.d.ts` file will augment these types
+
+## Learn More
+
+Visit [https://blimu.com](https://blimu.com) for documentation and more information.

package/dist/index.d.mts

@@ -0,0 +1,52 @@
+/**
+ * @blimu/types - TypeScript type definitions for Blimu simple types
+ *
+ * These types are base definitions that are augmented by customer configuration
+ * via the `blimu codegen` command. The augmentation adds union types based on
+ * the customer's resource, entitlement, plan, and limit definitions.
+ *
+ * @example
+ * ```typescript
+ * import type { ResourceType } from '@blimu/types';
+ *
+ * // After running `blimu codegen`, ResourceType will be:
+ * // type ResourceType = 'organization' | 'workspace' | 'project';
+ * ```
+ */
+/**
+ * Resource type identifier
+ *
+ * This type is augmented by `blimu codegen` to include all resource types
+ * defined in your Blimu configuration.
+ */
+type ResourceType = string;
+/**
+ * Entitlement type identifier
+ *
+ * This type is augmented by `blimu codegen` to include all entitlement types
+ * defined in your Blimu configuration.
+ */
+type EntitlementType = string;
+/**
+ * Plan type identifier
+ *
+ * This type is augmented by `blimu codegen` to include all plan types
+ * defined in your Blimu configuration.
+ */
+type PlanType = string;
+/**
+ * Limit type identifier (resource-based limits)
+ *
+ * This type is augmented by `blimu codegen` to include all resource limit types
+ * defined in your Blimu configuration plans.
+ */
+type LimitType = string;
+/**
+ * Usage-based limit type identifier
+ *
+ * This type is augmented by `blimu codegen` to include all usage-based limit types
+ * defined in your Blimu configuration plans.
+ */
+type UsageLimitType = string;
+
+export type { EntitlementType, LimitType, PlanType, ResourceType, UsageLimitType };

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @blimu/types - TypeScript type definitions for Blimu simple types
+ *
+ * These types are base definitions that are augmented by customer configuration
+ * via the `blimu codegen` command. The augmentation adds union types based on
+ * the customer's resource, entitlement, plan, and limit definitions.
+ *
+ * @example
+ * ```typescript
+ * import type { ResourceType } from '@blimu/types';
+ *
+ * // After running `blimu codegen`, ResourceType will be:
+ * // type ResourceType = 'organization' | 'workspace' | 'project';
+ * ```
+ */
+/**
+ * Resource type identifier
+ *
+ * This type is augmented by `blimu codegen` to include all resource types
+ * defined in your Blimu configuration.
+ */
+type ResourceType = string;
+/**
+ * Entitlement type identifier
+ *
+ * This type is augmented by `blimu codegen` to include all entitlement types
+ * defined in your Blimu configuration.
+ */
+type EntitlementType = string;
+/**
+ * Plan type identifier
+ *
+ * This type is augmented by `blimu codegen` to include all plan types
+ * defined in your Blimu configuration.
+ */
+type PlanType = string;
+/**
+ * Limit type identifier (resource-based limits)
+ *
+ * This type is augmented by `blimu codegen` to include all resource limit types
+ * defined in your Blimu configuration plans.
+ */
+type LimitType = string;
+/**
+ * Usage-based limit type identifier
+ *
+ * This type is augmented by `blimu codegen` to include all usage-based limit types
+ * defined in your Blimu configuration plans.
+ */
+type UsageLimitType = string;
+
+export type { EntitlementType, LimitType, PlanType, ResourceType, UsageLimitType };

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @blimu/types - TypeScript type definitions for Blimu simple types\n *\n * These types are base definitions that are augmented by customer configuration\n * via the `blimu codegen` command. The augmentation adds union types based on\n * the customer's resource, entitlement, plan, and limit definitions.\n *\n * @example\n * ```typescript\n * import type { ResourceType } from '@blimu/types';\n *\n * // After running `blimu codegen`, ResourceType will be:\n * // type ResourceType = 'organization' | 'workspace' | 'project';\n * ```\n */\n\n/**\n * Resource type identifier\n *\n * This type is augmented by `blimu codegen` to include all resource types\n * defined in your Blimu configuration.\n */\nexport type ResourceType = string;\n\n/**\n * Entitlement type identifier\n *\n * This type is augmented by `blimu codegen` to include all entitlement types\n * defined in your Blimu configuration.\n */\nexport type EntitlementType = string;\n\n/**\n * Plan type identifier\n *\n * This type is augmented by `blimu codegen` to include all plan types\n * defined in your Blimu configuration.\n */\nexport type PlanType = string;\n\n/**\n * Limit type identifier (resource-based limits)\n *\n * This type is augmented by `blimu codegen` to include all resource limit types\n * defined in your Blimu configuration plans.\n */\nexport type LimitType = string;\n\n/**\n * Usage-based limit type identifier\n *\n * This type is augmented by `blimu codegen` to include all usage-based limit types\n * defined in your Blimu configuration plans.\n */\nexport type UsageLimitType = string;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/index.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@blimu/types",
+  "version": "0.1.0",
+  "description": "TypeScript type definitions for Blimu simple types",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "type-check": "tsc --noEmit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/blimu-dev/blimu-ts"
+  },
+  "author": "viniciusdacal",
+  "license": "MIT",
+  "keywords": [
+    "typescript",
+    "types",
+    "blimu"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^5.0.0"
+  }
+}