@majikah/majik-api 0.1.0 → 0.1.1

package/dist/constants.d.ts

@@ -0,0 +1,11 @@
+import { RateLimit, RateLimitFrequency } from "./types";
+export declare const DEFAULT_RATE_LIMIT: RateLimit;
+/**
+ * Hard ceiling for any rate limit set on a MajikAPI key.
+ * No key — regardless of trust level — may exceed this without bypassSafeLimit.
+ * Expressed in req/min for normalisation purposes; stored as a RateLimit for
+ * consistency with the rest of the API.
+ */
+export declare const MAX_RATE_LIMIT: RateLimit;
+/** Multipliers to convert each frequency unit into requests-per-minute. */
+export declare const TO_MINUTES: Record<RateLimitFrequency, number>;

package/dist/constants.js

@@ -0,0 +1,23 @@
+// ─────────────────────────────────────────────
+//  Constants
+// ─────────────────────────────────────────────
+export const DEFAULT_RATE_LIMIT = {
+    amount: 100,
+    frequency: "minutes",
+};
+/**
+ * Hard ceiling for any rate limit set on a MajikAPI key.
+ * No key — regardless of trust level — may exceed this without bypassSafeLimit.
+ * Expressed in req/min for normalisation purposes; stored as a RateLimit for
+ * consistency with the rest of the API.
+ */
+export const MAX_RATE_LIMIT = {
+    amount: 500,
+    frequency: "minutes",
+};
+/** Multipliers to convert each frequency unit into requests-per-minute. */
+export const TO_MINUTES = {
+    seconds: 1 / 60,
+    minutes: 1,
+    hours: 60,
+};

package/dist/majik-api.d.ts

@@ -1,12 +1,4 @@
 import type { DomainWhitelist, IPWhitelist, MajikAPICreateOptions, MajikAPIJSON, MajikAPISettings, RateLimit, RateLimitFrequency } from "./types";
-export declare const DEFAULT_RATE_LIMIT: RateLimit;
-/**
- * Hard ceiling for any rate limit set on a MajikAPI key.
- * No key — regardless of trust level — may exceed this without bypassSafeLimit.
- * Expressed in req/min for normalisation purposes; stored as a RateLimit for
- * consistency with the rest of the API.
- */
-export declare const MAX_RATE_LIMIT: RateLimit;
 export declare class MajikAPI {
     private readonly _id;
     private readonly _owner_id;

package/dist/majik-api.js

@@ -1,108 +1,5 @@
-import { generateID, sha256 } from "./utils";
-// ─────────────────────────────────────────────
-//  Constants
-// ─────────────────────────────────────────────
-export const DEFAULT_RATE_LIMIT = {
-    amount: 100,
-    frequency: "minutes",
-};
-/**
- * Hard ceiling for any rate limit set on a MajikAPI key.
- * No key — regardless of trust level — may exceed this without bypassSafeLimit.
- * Expressed in req/min for normalisation purposes; stored as a RateLimit for
- * consistency with the rest of the API.
- */
-export const MAX_RATE_LIMIT = {
-    amount: 500,
-    frequency: "minutes",
-};
-/** Multipliers to convert each frequency unit into requests-per-minute. */
-const TO_MINUTES = {
-    seconds: 1 / 60,
-    minutes: 1,
-    hours: 60,
-};
-// ─────────────────────────────────────────────
-//  Validation Helpers
-// ─────────────────────────────────────────────
-function assertString(value, label) {
-    if (typeof value !== "string" || value.trim() === "") {
-        throw new TypeError(`[MajikAPI] "${label}" must be a non-empty string. Received: ${JSON.stringify(value)}`);
-    }
-}
-function assertPositiveInteger(value, label) {
-    if (typeof value !== "number" || !Number.isInteger(value) || value < 1) {
-        throw new RangeError(`[MajikAPI] "${label}" must be a positive integer. Received: ${JSON.stringify(value)}`);
-    }
-}
-function assertRateLimitFrequency(value, label) {
-    const valid = ["seconds", "minutes", "hours"];
-    if (!valid.includes(value)) {
-        throw new TypeError(`[MajikAPI] "${label}" must be one of: ${valid.join(", ")}. Received: ${JSON.stringify(value)}`);
-    }
-}
-function assertBoolean(value, label) {
-    if (typeof value !== "boolean") {
-        throw new TypeError(`[MajikAPI] "${label}" must be a boolean. Received: ${JSON.stringify(value)}`);
-    }
-}
-function assertStringArray(value, label) {
-    if (!Array.isArray(value) || value.some((v) => typeof v !== "string")) {
-        throw new TypeError(`[MajikAPI] "${label}" must be an array of strings. Received: ${JSON.stringify(value)}`);
-    }
-}
-function isValidIPv4(ip) {
-    return (/^(\d{1,3}\.){3}\d{1,3}$/.test(ip) &&
-        ip.split(".").every((o) => parseInt(o) <= 255));
-}
-function isValidIPv6(ip) {
-    return /^[0-9a-fA-F:]+$/.test(ip) && ip.includes(":");
-}
-function isValidCIDR(cidr) {
-    const [ip, prefix] = cidr.split("/");
-    if (!prefix)
-        return false;
-    const p = parseInt(prefix);
-    return ((isValidIPv4(ip) && p >= 0 && p <= 32) ||
-        (isValidIPv6(ip) && p >= 0 && p <= 128));
-}
-function validateIP(ip) {
-    if (!isValidIPv4(ip) && !isValidIPv6(ip) && !isValidCIDR(ip)) {
-        throw new Error(`[MajikAPI] Invalid IP address or CIDR: "${ip}"`);
-    }
-}
-function isValidDomain(domain) {
-    return (/^(\*\.)?[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z]{2,})+$/.test(domain) || /^\*$/.test(domain));
-}
-function validateDomain(domain) {
-    if (!isValidDomain(domain)) {
-        throw new Error(`[MajikAPI] Invalid domain: "${domain}"`);
-    }
-}
-function isValidISODate(value) {
-    const d = new Date(value);
-    return !isNaN(d.getTime());
-}
-// ─────────────────────────────────────────────
-//  Default Settings Factory
-// ─────────────────────────────────────────────
-function buildDefaultSettings(overrides) {
-    return {
-        rateLimit: { ...DEFAULT_RATE_LIMIT, ...(overrides?.rateLimit ?? {}) },
-        ipWhitelist: {
-            enabled: false,
-            addresses: [],
-            ...(overrides?.ipWhitelist ?? {}),
-        },
-        domainWhitelist: {
-            enabled: false,
-            domains: [],
-            ...(overrides?.domainWhitelist ?? {}),
-        },
-        allowedMethods: overrides?.allowedMethods ?? [],
-        metadata: overrides?.metadata ?? {},
-    };
-}
+import { DEFAULT_RATE_LIMIT, MAX_RATE_LIMIT, TO_MINUTES } from "./constants";
+import { assertBoolean, assertPositiveInteger, assertRateLimitFrequency, assertString, assertStringArray, buildDefaultSettings, generateID, isValidISODate, sha256, validateDomain, validateIP, } from "./utils";
 // ─────────────────────────────────────────────
 //  MajikAPI Class
 // ─────────────────────────────────────────────
@@ -262,9 +159,6 @@ export class MajikAPI {
         assertString(this._owner_id, "owner_id");
         assertString(this._name, "name");
         assertString(this._api_key, "api_key");
-        if (!/^[a-f0-9]{64}$/.test(this._api_key)) {
-            throw new Error("[MajikAPI] validate(): 'api_key' does not appear to be a valid SHA-256 hash.");
-        }
         if (!(this._timestamp instanceof Date) ||
             isNaN(this._timestamp.getTime())) {
             throw new TypeError("[MajikAPI] validate(): 'timestamp' is not a valid Date.");

package/dist/utils.d.ts

@@ -1,6 +1,20 @@
+import { MajikAPISettings, RateLimitFrequency } from "./types";
 export declare function sha256(input: string): string;
 export declare function arrayToBase64(data: Uint8Array): string;
 /**
  * Generate a Random v4 UUID
  */
 export declare function generateID(): string;
+export declare function assertString(value: unknown, label: string): asserts value is string;
+export declare function assertPositiveInteger(value: unknown, label: string): asserts value is number;
+export declare function assertRateLimitFrequency(value: unknown, label: string): asserts value is RateLimitFrequency;
+export declare function assertBoolean(value: unknown, label: string): asserts value is boolean;
+export declare function assertStringArray(value: unknown, label: string): asserts value is string[];
+export declare function isValidIPv4(ip: string): boolean;
+export declare function isValidIPv6(ip: string): boolean;
+export declare function isValidCIDR(cidr: string): boolean;
+export declare function validateIP(ip: string): void;
+export declare function isValidDomain(domain: string): boolean;
+export declare function validateDomain(domain: string): void;
+export declare function isValidISODate(value: string): boolean;
+export declare function buildDefaultSettings(overrides?: Partial<MajikAPISettings>): MajikAPISettings;

package/dist/utils.js

@@ -1,5 +1,6 @@
 import { hash } from "@stablelib/sha256";
 import { v4 as uuidv4 } from "uuid";
+import { DEFAULT_RATE_LIMIT } from "./constants";
 export function sha256(input) {
     const hashed = hash(new TextEncoder().encode(input));
     return arrayToBase64(hashed);
@@ -25,3 +26,84 @@ export function generateID() {
         throw new Error(`Failed to generate ID: ${error}`);
     }
 }
+// ─────────────────────────────────────────────
+//  Validation Helpers
+// ─────────────────────────────────────────────
+export function assertString(value, label) {
+    if (typeof value !== "string" || value.trim() === "") {
+        throw new TypeError(`[MajikAPI] "${label}" must be a non-empty string. Received: ${JSON.stringify(value)}`);
+    }
+}
+export function assertPositiveInteger(value, label) {
+    if (typeof value !== "number" || !Number.isInteger(value) || value < 1) {
+        throw new RangeError(`[MajikAPI] "${label}" must be a positive integer. Received: ${JSON.stringify(value)}`);
+    }
+}
+export function assertRateLimitFrequency(value, label) {
+    const valid = ["seconds", "minutes", "hours"];
+    if (!valid.includes(value)) {
+        throw new TypeError(`[MajikAPI] "${label}" must be one of: ${valid.join(", ")}. Received: ${JSON.stringify(value)}`);
+    }
+}
+export function assertBoolean(value, label) {
+    if (typeof value !== "boolean") {
+        throw new TypeError(`[MajikAPI] "${label}" must be a boolean. Received: ${JSON.stringify(value)}`);
+    }
+}
+export function assertStringArray(value, label) {
+    if (!Array.isArray(value) || value.some((v) => typeof v !== "string")) {
+        throw new TypeError(`[MajikAPI] "${label}" must be an array of strings. Received: ${JSON.stringify(value)}`);
+    }
+}
+export function isValidIPv4(ip) {
+    return (/^(\d{1,3}\.){3}\d{1,3}$/.test(ip) &&
+        ip.split(".").every((o) => parseInt(o) <= 255));
+}
+export function isValidIPv6(ip) {
+    return /^[0-9a-fA-F:]+$/.test(ip) && ip.includes(":");
+}
+export function isValidCIDR(cidr) {
+    const [ip, prefix] = cidr.split("/");
+    if (!prefix)
+        return false;
+    const p = parseInt(prefix);
+    return ((isValidIPv4(ip) && p >= 0 && p <= 32) ||
+        (isValidIPv6(ip) && p >= 0 && p <= 128));
+}
+export function validateIP(ip) {
+    if (!isValidIPv4(ip) && !isValidIPv6(ip) && !isValidCIDR(ip)) {
+        throw new Error(`[MajikAPI] Invalid IP address or CIDR: "${ip}"`);
+    }
+}
+export function isValidDomain(domain) {
+    return (/^(\*\.)?[a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z]{2,})+$/.test(domain) || /^\*$/.test(domain));
+}
+export function validateDomain(domain) {
+    if (!isValidDomain(domain)) {
+        throw new Error(`[MajikAPI] Invalid domain: "${domain}"`);
+    }
+}
+export function isValidISODate(value) {
+    const d = new Date(value);
+    return !isNaN(d.getTime());
+}
+// ─────────────────────────────────────────────
+//  Default Settings Factory
+// ─────────────────────────────────────────────
+export function buildDefaultSettings(overrides) {
+    return {
+        rateLimit: { ...DEFAULT_RATE_LIMIT, ...(overrides?.rateLimit ?? {}) },
+        ipWhitelist: {
+            enabled: false,
+            addresses: [],
+            ...(overrides?.ipWhitelist ?? {}),
+        },
+        domainWhitelist: {
+            enabled: false,
+            domains: [],
+            ...(overrides?.domainWhitelist ?? {}),
+        },
+        allowedMethods: overrides?.allowedMethods ?? [],
+        metadata: overrides?.metadata ?? {},
+    };
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@majikah/majik-api",
   "type": "module",
   "description": "A high-security API key management library for TypeScript. Handles generation, SHA-256 hashing, and lifecycle management including rate limiting, IP/domain whitelisting, and secure key rotation.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "Apache-2.0",
   "author": "Zelijah",
   "main": "./dist/index.js",