@easyhook/core 1.0.2 → 1.4.0

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@easyhook/core",
-  "version": "1.0.2",
+  "version": "1.4.0",
   "publishConfig": {
     "access": "public"
   },
   "private": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",

package/.swcrc

@@ -1,29 +0,0 @@
-{
-  "jsc": {
-    "target": "es2017",
-    "parser": {
-      "syntax": "typescript",
-      "decorators": true,
-      "dynamicImport": true
-    },
-    "transform": {
-      "decoratorMetadata": true,
-      "legacyDecorator": true
-    },
-    "keepClassNames": true,
-    "externalHelpers": true,
-    "loose": true
-  },
-  "module": {
-    "type": "es6"
-  },
-  "sourceMaps": true,
-  "exclude": [
-    "jest.config.[ct]s",
-    ".*\\.spec.tsx?$",
-    ".*\\.test.tsx?$",
-    "./src/jest-setup.ts$",
-    "./**/jest-setup.ts$",
-    ".*.js$"
-  ]
-}

package/eslint.config.mjs

@@ -1,25 +0,0 @@
-import baseConfig from '../../eslint.config.mjs';
-
-export default [
-  ...baseConfig,
-  {
-    files: ['**/*.json'],
-    rules: {
-      '@nx/dependency-checks': [
-        'error',
-        {
-          ignoredFiles: [
-            '{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}',
-            '{projectRoot}/vite.config.{js,ts,mjs,mts}',
-          ],
-        },
-      ],
-    },
-    languageOptions: {
-      parser: await import('jsonc-eslint-parser'),
-    },
-  },
-  {
-    ignores: ['**/out-tsc'],
-  },
-];

package/src/core/base.ts

@@ -1,51 +0,0 @@
-import { TypedEmitter } from 'tiny-typed-emitter';
-import { BaseEvents } from '../types/events.js';
-import { HookIntentValue } from '../utils/intents.js';
-import { HookProvider } from '../utils/provider.js';
-import { EasydonateSchema, GithubPushSchema } from '../validator/index.js';
-import { type } from 'arktype';
-import { WebhookValidationError } from '../validator/custom.js';
-
-export interface EasyhookOptions {
-  intents: HookIntentValue[];
-}
-
-export class Easyhook extends TypedEmitter<BaseEvents> {
-  private enabledIntents: Set<string>;
-
-  constructor(options: EasyhookOptions) {
-    super();
-    this.enabledIntents = new Set(options.intents);
-  }
-
-  public isWebhook(provider: HookProvider, body: unknown) {
-    if (!this.enabledIntents.has(provider)) {
-      throw new Error(`Intent for ${provider} is not enabled`);
-    }
-
-    switch (provider) {
-      case HookProvider.EasyDonate: {
-        const input = EasydonateSchema(body);
-
-        if (input instanceof type.errors) {
-          throw new WebhookValidationError(provider, input.summary);
-        }
-
-        this.emit('easydonate', input);
-        break;
-      }
-      case HookProvider.Github: {
-        const input = GithubPushSchema(body);
-
-        if (input instanceof type.errors) {
-          throw new WebhookValidationError(provider, input.summary);
-        }
-
-        this.emit('github', input);
-        break;
-      }
-      default:
-        throw new Error(`Unhandled provider: ${provider}`);
-    }
-  }
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from './core/base.js';
-export * from './utils/index.js';
-export * from './validator/index.js';
-export * from './types/events.js';
-export * from './types/payload.js';

package/src/lib/github.spec.ts

@@ -1,106 +0,0 @@
-import { describe, it, expect, vi } from 'vitest';
-import { Easyhook } from '../core/base.js';
-import { HookProvider } from '../utils/provider.js';
-
-describe('Github Webhook Provider', () => {
-  it('should handle github push event and emit "github"', () => {
-    const easyhook = new Easyhook({
-      intents: ['github'],
-    });
-
-    const spy = vi.fn();
-    easyhook.on('github', spy);
-
-    const payload = {
-      ref: 'refs/heads/main',
-      before: 'before-hash',
-      after: 'after-hash',
-      repository: {
-        id: 123456,
-        name: 'test-repo',
-        full_name: 'owner/test-repo',
-        private: false,
-        owner: {
-          name: 'owner',
-          email: 'owner@example.com',
-          login: 'owner',
-          id: 1,
-          avatar_url: 'https://avatar.url',
-          url: 'https://api.github.com/users/owner',
-        },
-        html_url: 'https://github.com/owner/test-repo',
-        description: 'Test Repository',
-        fork: false,
-        url: 'https://api.github.com/repos/owner/test-repo',
-        created_at: 1234567890,
-        updated_at: '2023-01-01T00:00:00Z',
-        pushed_at: 1234567890,
-        homepage: null,
-        size: 100,
-        stargazers_count: 10,
-        watchers_count: 10,
-        language: 'TypeScript',
-        has_issues: true,
-        has_projects: true,
-        has_downloads: true,
-        has_wiki: true,
-        has_pages: false,
-        forks_count: 0,
-        mirror_url: null,
-        open_issues_count: 0,
-        forks: 0,
-        open_issues: 0,
-        watchers: 10,
-        default_branch: 'main',
-      },
-      pusher: {
-        name: 'pusher',
-        email: 'pusher@example.com',
-      },
-      sender: {
-        login: 'sender',
-        id: 2,
-        avatar_url: 'https://avatar.url',
-        url: 'https://api.github.com/users/sender',
-      },
-      commits: [
-        {
-          id: 'commit-hash',
-          tree_id: 'tree-hash',
-          distinct: true,
-          message: 'feat: add github webhook',
-          timestamp: '2023-01-01T00:00:00Z',
-          url: 'https://github.com/owner/test-repo/commit/commit-hash',
-          author: {
-            name: 'author',
-            email: 'author@example.com',
-            username: 'author',
-          },
-          committer: {
-            name: 'committer',
-            email: 'committer@example.com',
-            username: 'committer',
-          },
-          added: [],
-          removed: [],
-          modified: ['packages/core/src/index.ts'],
-        },
-      ],
-    };
-
-    easyhook.isWebhook(HookProvider.Github, payload);
-
-    expect(spy).toHaveBeenCalledTimes(1);
-    expect(spy).toHaveBeenCalledWith(payload);
-  });
-
-  it('should throw error if provider is not enabled', () => {
-    const easyhook = new Easyhook({
-      intents: ['easydonate'], // Github not enabled
-    });
-
-    expect(() => {
-      easyhook.isWebhook(HookProvider.Github, {});
-    }).toThrow('Intent for github is not enabled');
-  });
-});

package/src/types/events.ts

@@ -1,6 +0,0 @@
-import type { EasyDonatePayload, GithubPushPayload } from './payload.js';
-
-export interface BaseEvents {
-  easydonate: (payload: EasyDonatePayload) => void;
-  github: (payload: GithubPushPayload) => void;
-}

package/src/types/payload.ts

@@ -1,5 +0,0 @@
-import { EasydonateSchema } from '../validator/easydonate.js';
-import { GithubPushSchema } from '../validator/github.js';
-
-export type EasyDonatePayload = typeof EasydonateSchema.infer;
-export type GithubPushPayload = typeof GithubPushSchema.infer;

package/src/utils/index.ts

@@ -1,2 +0,0 @@
-export * from './provider.js';
-export * from './intents.js';

package/src/utils/intents.ts

@@ -1,8 +0,0 @@
-import { HookProvider } from './provider.js';
-
-export const HookIntents = {
-  EasyDonate: HookProvider.EasyDonate,
-  Github: HookProvider.Github,
-} as const;
-
-export type HookIntentValue = (typeof HookIntents)[keyof typeof HookIntents];

package/src/utils/provider.ts

@@ -1,6 +0,0 @@
-export const HookProvider = {
-  EasyDonate: 'easydonate',
-  Github: 'github',
-} as const;
-
-export type HookProvider = (typeof HookProvider)[keyof typeof HookProvider];

package/src/validator/custom.ts

@@ -1,6 +0,0 @@
-export class WebhookValidationError extends Error {
-  constructor(public provider: string, public details: string) {
-    super(`Invalid Payload for ${provider}`);
-    this.name = 'WebhookValidationError';
-  }
-}

package/src/validator/easydonate.ts

@@ -1,11 +0,0 @@
-import { type } from 'arktype';
-
-export const EasydonateSchema = type({
-  provider: "'easydonate'",
-  referenceNo: 'string',
-  channelName: 'string',
-  donatorName: 'string',
-  donateMessage: 'string',
-  amount: 'number',
-  time: 'string',
-});

package/src/validator/github.ts

@@ -1,130 +0,0 @@
-import { type } from 'arktype';
-
-export const GithubPushSchema = type({
-  ref: 'string',
-  before: 'string',
-  after: 'string',
-  repository: {
-    id: 'number',
-    name: 'string',
-    full_name: 'string',
-    private: 'boolean',
-    owner: {
-      name: 'string',
-      email: 'string?',
-      login: 'string',
-      id: 'number',
-      avatar_url: 'string',
-      url: 'string',
-    },
-    html_url: 'string',
-    description: 'string|null',
-    fork: 'boolean',
-    url: 'string',
-    created_at: 'number|string',
-    updated_at: 'string',
-    pushed_at: 'number|string',
-    homepage: 'string|null',
-    size: 'number',
-    stargazers_count: 'number',
-    watchers_count: 'number',
-    language: 'string|null',
-    has_issues: 'boolean',
-    has_projects: 'boolean',
-    has_downloads: 'boolean',
-    has_wiki: 'boolean',
-    has_pages: 'boolean',
-    forks_count: 'number',
-    mirror_url: 'string|null',
-    open_issues_count: 'number',
-    forks: 'number',
-    open_issues: 'number',
-    watchers: 'number',
-    default_branch: 'string',
-  },
-  pusher: {
-    name: 'string',
-    email: 'string?',
-  },
-  sender: {
-    login: 'string',
-    id: 'number',
-    avatar_url: 'string',
-    url: 'string',
-  },
-  commits: type([
-    {
-      id: 'string',
-      tree_id: 'string',
-      distinct: 'boolean',
-      message: 'string',
-      timestamp: 'string',
-      url: 'string',
-      author: {
-        name: 'string',
-        email: 'string',
-        username: 'string?',
-      },
-      committer: {
-        name: 'string',
-        email: 'string',
-        username: 'string?',
-      },
-      added: 'string[]',
-      removed: 'string[]',
-      modified: 'string[]',
-    },
-    '[]',
-  ]),
-  'head_commit?': {
-    id: 'string',
-    tree_id: 'string',
-    distinct: 'boolean',
-    message: 'string',
-    timestamp: 'string',
-    url: 'string',
-    author: {
-      name: 'string',
-      email: 'string',
-      username: 'string?',
-    },
-    committer: {
-      name: 'string',
-      email: 'string',
-      username: 'string?',
-    },
-    added: 'string[]',
-    removed: 'string[]',
-    modified: 'string[]',
-  } as const as any, // ArkType doesn't support complex union literals in object keys easily without separate definition or helper, but wait. The user suggested: "'head_commit?': '{ ... } | null'".
-  // Let's use the object definition form but wrapped in a union if possible or just use '...|null' string def if it was a string.
-  // Since it's an object definition, I can't just make the key a string like 'head_commit?': '... | null'.
-  // I need to check how arktype handles optional nullable objects.
-  // Actually, arktype `type({...})` takes an object.
-  // If I want it to be nullable, I might need to define the object type separately.
-  // OR, I can use the string format for the whole property if I could serialize the object schema.
-  // BUT, looking at the user request: "change the field type to the object OR null, e.g., "'head_commit?': '{ ... } | null'""
-  // This implies ArkType supports defining the value as a type definition.
-  // Wait, the existing code uses object literal syntax for `head_commit`.
-  // I will try to use the `type` wrapper for the value or just union it if ArkType allows `type({ key: { ... } | null })` (syntax error in TS).
-  // The user suggestion: `head_commit?: ... | null`.
-  // Let's try to define the inner object schema and union it with null.
-  // Actually, simplest is to use `type` for the inner object?
-  // Let's look at `repository` definition in lines 7-44. It is nested object.
-  // If I want `head_commit` to be nullable, I should probably do:
-  // 'head_commit?': type({ ... }).or('null')
-  // Let's see if I can do that.
-  // User said: "allow null using arktype's union syntax ... e.g., "'head_commit?': '{ ... } | null'""
-  // Maybe they meant replacing the object literal with a string representation if arktype supports it?
-  // But `head_commit` has many fields.
-  // I will define the `HeadCommitSchema` string constant or object and use it? No, keep it inline if possible.
-  // PROPOSED FIX:
-  // 'head_commit?': type({ ... }).or('null') if that works.
-  // OR, maybe stricter: validation might fail if I just hack it.
-  // Let's assume `type({ ... })` returns a Type.
-  // So: `'head_commit?': type({ ... }).or('null')` should be valid JS/TS if `type` comes from `arktype`.
-  // However, `head_commit?` is a key in the object passed to outer `type()`.
-  // So the value must be a definition.
-  // `type({ ... })` is a Type, which is a valid definition.
-  // So I will convert the object literal to `type({...}).or('null')`.
-});

package/src/validator/index.ts

@@ -1,3 +0,0 @@
-export * from './easydonate.js';
-export * from './github.js';
-export * from './custom.js';

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,28 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": ".",
-    "rootDir": "src",
-    "outDir": "dist",
-    "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
-    "emitDeclarationOnly": true,
-    "forceConsistentCasingInFileNames": true,
-    "types": ["node"]
-  },
-  "include": ["src/**/*.ts"],
-  "references": [],
-  "exclude": [
-    "vite.config.ts",
-    "vite.config.mts",
-    "vitest.config.ts",
-    "vitest.config.mts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx"
-  ]
-}

package/tsconfig.spec.json

@@ -1,36 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "./out-tsc/vitest",
-    "types": [
-      "vitest/globals",
-      "vitest/importMeta",
-      "vite/client",
-      "node",
-      "vitest"
-    ],
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": [
-    "vite.config.ts",
-    "vite.config.mts",
-    "vitest.config.ts",
-    "vitest.config.mts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.test.tsx",
-    "src/**/*.spec.tsx",
-    "src/**/*.test.js",
-    "src/**/*.spec.js",
-    "src/**/*.test.jsx",
-    "src/**/*.spec.jsx",
-    "src/**/*.d.ts",
-    "src/types/payload.ts",
-    "src/types/events.ts"
-  ],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    }
-  ]
-}

package/vite.config.ts

@@ -1,24 +0,0 @@
-/// <reference types='vitest' />
-import { defineConfig } from 'vite';
-
-export default defineConfig(() => ({
-  root: import.meta.dirname,
-  cacheDir: '../../node_modules/.vite/packages/core',
-  plugins: [],
-  // Uncomment this if you are using workers.
-  // worker: {
-  //  plugins: [],
-  // },
-  test: {
-    name: '@easyhook/core',
-    watch: false,
-    globals: true,
-    environment: 'node',
-    include: ['{src,tests}/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
-    reporters: ['default'],
-    coverage: {
-      reportsDirectory: './test-output/vitest/coverage',
-      provider: 'v8' as const,
-    },
-  },
-}));

package/vitest.config.mts

@@ -1,22 +0,0 @@
-import { defineConfig } from 'vitest/config';
-import { fileURLToPath } from 'url';
-import { dirname } from 'path';
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-
-export default defineConfig(() => ({
-  root: __dirname,
-  cacheDir: '../../node_modules/.vite/packages/core',
-  test: {
-    name: '@easyhook/core',
-    watch: false,
-    globals: true,
-    environment: 'node',
-    include: ['{src,tests}/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
-    reporters: ['default'],
-    coverage: {
-      reportsDirectory: './test-output/vitest/coverage',
-      provider: 'v8' as const,
-    },
-  },
-}));