slackblock 0.4.0 → 1.0.0-0

package/dist/types.d-DgQXbJte.d.ts

@@ -0,0 +1,296 @@
+import { ReactElement } from 'react';
+
+type TextType$1 = {
+    type: 'plain_text' | 'mrkdwn';
+    text: string;
+    emoji?: boolean;
+    verbatim?: boolean;
+};
+
+type TextType = {
+    type: 'plain_text_input';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_value?: string;
+    multiline?: boolean;
+    min_length?: number;
+    max_length?: number;
+    focus_on_load?: boolean;
+    dispatch_action_config?: {
+        trigger_actions_on: Array<'on_enter_pressed' | 'on_character_entered'>;
+    };
+};
+
+type ConfirmationType = {
+    title: TextType$1;
+    text: TextType$1;
+    confirm: TextType$1;
+    deny: TextType$1;
+};
+
+type DatePickerType = {
+    type: 'datepicker';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_date?: string;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type OptionType = {
+    text: TextType$1;
+    value: string;
+    description?: TextType$1;
+    url?: string;
+};
+
+type OptionGroupType = {
+    label: TextType$1;
+    options: OptionType[];
+};
+
+type ValidSelectType = 'static_select' | 'multi_static_select' | 'external_select' | 'multi_external_select' | 'users_select' | 'multi_users_select' | 'conversations_select' | 'multi_conversations_select' | 'channels_select' | 'multi_channels_select';
+type SelectType = {
+    type: ValidSelectType;
+    placeholder: TextType$1;
+    action_id: string;
+    options?: OptionType[];
+    option_groups?: OptionGroupType[];
+    initial_option?: OptionType;
+    initial_options?: OptionType[];
+    confirm?: ConfirmationType;
+    max_selected_items?: number;
+    min_query_length?: number;
+    focus_on_load?: boolean;
+    initial_user?: string;
+    initial_users?: string[];
+    initial_conversation?: string;
+    initial_conversations?: string[];
+    initial_channel?: string;
+    initial_channels?: string[];
+    default_to_current_conversation?: boolean;
+    response_url_enabled?: boolean;
+    filter?: {
+        include?: Array<'im' | 'mpim' | 'private' | 'public'>;
+        exclude_external_shared_channels?: boolean;
+        exclude_bot_users?: boolean;
+    };
+};
+
+type CheckboxesType = {
+    type: 'checkboxes';
+    action_id: string;
+    options: OptionType[];
+    initial_options?: OptionType[];
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type TimePickerType = {
+    type: 'timepicker';
+    action_id: string;
+    placeholder?: TextType$1;
+    initial_time?: string;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type DateTimePickerType = {
+    type: 'datetimepicker';
+    action_id: string;
+    initial_date_time?: number;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type OverflowType = {
+    type: 'overflow';
+    action_id: string;
+    options: OptionType[];
+    confirm?: ConfirmationType;
+};
+
+type RadioGroupType = {
+    type: 'radio_buttons';
+    action_id: string;
+    options: OptionType[];
+    initial_option?: OptionType;
+    confirm?: ConfirmationType;
+    focus_on_load?: boolean;
+};
+
+type ImageType$1 = {
+    type: 'image';
+    image_url: string;
+    alt_text: string;
+};
+
+type ButtonType = {
+    type: 'button';
+    text: TextType$1;
+    action_id: string;
+    url?: string;
+    value?: string;
+    style?: 'primary' | 'danger';
+    confirm?: ConfirmationType;
+    accessibility_label?: string;
+};
+
+type ActionType = {
+    type: 'actions';
+    elements: SerializedInteractiveBlockElement[];
+    block_id?: string;
+};
+
+type ImageOrText = ImageType$1 | TextType$1;
+type ContextType = {
+    type: 'context';
+    elements: ImageOrText | ImageOrText[];
+    block_id?: string;
+};
+
+type DividerType = {
+    type: 'divider';
+    block_id?: string;
+};
+
+type FileType = {
+    type: 'file';
+    source: 'remote';
+    external_id: string;
+    block_id?: string;
+};
+
+type HeaderType = {
+    type: 'header';
+    text: TextType$1;
+    block_id?: string;
+};
+
+type ImageType = {
+    type: 'image';
+    image_url: string;
+    alt_text: string;
+    title?: TextType$1;
+    block_id?: string;
+};
+
+type InputType = {
+    type: 'input';
+    label: TextType$1;
+    element: SerializedInputBlockElement;
+    hint?: TextType$1;
+    optional?: boolean;
+    block_id?: string;
+};
+
+type RichTextType = {
+    type: 'rich_text';
+    elements: Array<Record<string, unknown>>;
+    block_id?: string;
+};
+
+type SectionType = {
+    type: 'section';
+    text: TextType$1;
+    block_id?: string;
+    fields?: TextType$1[];
+    accessory?: SerializedBlockElement;
+};
+
+type VideoType = {
+    type: 'video';
+    title: TextType$1;
+    video_url: string;
+    thumbnail_url: string;
+    alt_text: string;
+    title_url?: string;
+    description?: TextType$1;
+    author_name?: string;
+    provider_name?: string;
+    provider_icon_url?: string;
+    block_id?: string;
+};
+
+type ImageBlockType = ImageType$1 | ImageType;
+
+type SerializedInputBlockElement =
+  | TextType
+  | DatePickerType
+  | DateTimePickerType
+  | TimePickerType
+  | CheckboxesType
+  | SelectType
+  | OverflowType
+  | RadioGroupType;
+
+type SerializedInteractiveBlockElement =
+  | ButtonType
+  | SerializedInputBlockElement;
+
+type SerializedBlockElement =
+  | TextType$1
+  | ImageBlockType
+  | ConfirmationType
+  | SerializedInteractiveBlockElement;
+
+type SerializedBlock =
+  | SectionType
+  | ActionType
+  | ContextType
+  | DividerType
+  | FileType
+  | HeaderType
+  | ImageBlockType
+  | InputType
+  | RichTextType
+  | VideoType;
+
+type Block = SerializedBlock;
+type Attachment = {
+  color: string;
+  blocks: Block[];
+};
+
+type InteractiveBlockElement = ReactElement<any, any>;
+type StandardBlockElement = ReactElement<any, any>;
+
+type InputBlockElement = ReactElement<any, any>;
+type BlockElement = InteractiveBlockElement | StandardBlockElement | InputBlockElement;
+
+type SlackMessage = {
+  text?: string;
+  as_user?: boolean;
+  blocks?: Block[];
+  attachments?: Attachment[];
+  icon_emoji?: string;
+  icon_url?: string;
+  link_names?: boolean;
+  mrkdwn?: boolean;
+  parse?: 'full' | 'none';
+  reply_broadcast?: boolean;
+  thread_ts?: string;
+  unfurl_links?: boolean;
+  unfurl_media?: boolean;
+  username?: string;
+};
+
+type AnyFunction = (...parameters: any[]) => any;
+
+type AnyConstructor = new (...parameters: any[]) => any;
+
+type WithType = {
+  type?: string | AnyFunction | AnyConstructor;
+};
+type BElement = ReactElement<any, any> & WithType;
+type Element = BElement;
+type Child =
+  | string
+  | Element
+  | Child[]
+  | boolean
+  | undefined
+  // eslint-disable-next-line @typescript-eslint/no-restricted-types -- React children can be null.
+  | null;
+
+export type { BlockElement as B, Child as C, Element as E, InteractiveBlockElement as I, SlackMessage as S, InputBlockElement as a };

package/package.json

@@ -1,135 +1,85 @@
-{
-  "name": "slackblock",
-  "version": "0.4.0",
-  "description": "React-based Slack message renderer",
-  "main": "index.js",
-  "scripts": {
-    "test": "npm-run-all test:*",
-    "test:tsc": "tsc -p ./src -p ./test --noEmit",
-    "test:lint": "xo",
-    "test:unit": "ava",
-    "build": "npm-run-all build:*",
-    "build:package": "tsc -p .",
-    "prepublish": "npm-run-all test:* build:*"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/kolyaventuri/block.git"
-  },
-  "keywords": [
-    "react",
-    "slack",
-    "message",
-    "bot"
-  ],
-  "author": "Kolya Venturi <me@kolya.co>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/kolyaventuri/block/issues"
-  },
-  "homepage": "https://github.com/kolyaventuri/block#readme",
-  "devDependencies": {
-    "@types/proxyquire": "^1.3.28",
-    "@types/react": "^16.9.13",
-    "@types/sinon": "^7.5.1",
-    "@typescript-eslint/eslint-plugin": "^2.9.0",
-    "@typescript-eslint/parser": "^2.9.0",
-    "ava": "^2.4.0",
-    "coveralls": "^3.0.9",
-    "enzyme": "^3.10.0",
-    "enzyme-adapter-react-16": "^1.15.1",
-    "eslint": "^6.7.1",
-    "eslint-config-xo": "^0.27.2",
-    "eslint-config-xo-react": "^0.20.0",
-    "eslint-config-xo-typescript": "^0.23.0",
-    "eslint-plugin-react": "^7.16.0",
-    "eslint-plugin-react-hooks": "^2.3.0",
-    "npm-run-all": "^4.1.5",
-    "nyc": "^14.1.1",
-    "pre-commit": "^1.2.2",
-    "proxyquire": "^2.1.3",
-    "sinon": "^7.5.0",
-    "ts-node": "^8.5.2",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^3.7.2",
-    "xo": "^0.25.3"
-  },
-  "pre-commit": [
-    "test:tsc",
-    "test:lint"
-  ],
-  "xo": {
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-      "project": [
-        "./src/tsconfig.json",
-        "./test/tsconfig.json"
-      ]
-    },
-    "extends": [
-      "xo-typescript",
-      "plugin:@typescript-eslint/recommended",
-      "xo-react/space"
-    ],
-    "extensions": [
-      "ts"
-    ],
-    "space": true,
-    "compilerOptions": {
-      "strict": true
-    },
-    "rules": {
-      "@typescript-eslint/camelcase": 0,
-      "react/jsx-fragments": [
-        2,
-        "element"
-      ],
-      "@typescript-eslint/member-naming": [
-        "error",
-        {
-          "private": "^__",
-          "protected": "^_"
-        }
-      ],
-      "indent": 0,
-      "@typescript-eslint/indent": [
-        "error",
-        2
-      ]
-    },
-    "settings": {
-      "react": {
-        "version": "16.5"
-      }
-    },
-    "env": [
-      "node"
-    ],
-    "include": [
-      "**/*.ts?(x)"
-    ],
-    "ignore": [
-      "*.js"
-    ]
-  },
-  "ava": {
-    "compileEnhancements": false,
-    "extensions": [
-      "ts",
-      "tsx"
-    ],
-    "files": [
-      "test/**/*.test.ts?(x)"
-    ],
-    "helpers": [
-      "test/helpers/**/*.ts"
-    ],
-    "require": [
-      "ts-node/register",
-      "tsconfig-paths/register"
-    ]
-  },
-  "dependencies": {
-    "react": "^16.12.0"
-  }
-}
+{
+  "name": "slackblock",
+  "version": "1.0.0-0",
+  "description": "JSX-based Slack message renderer",
+  "engines": {
+    "node": ">=24"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
+    },
+    "./block": {
+      "types": "./dist/block.d.ts",
+      "import": "./dist/block.mjs",
+      "require": "./dist/block.cjs",
+      "default": "./dist/block.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kolyaventuri/block.git"
+  },
+  "keywords": [
+    "react",
+    "slack",
+    "message",
+    "bot"
+  ],
+  "author": "Kolya Venturi <me@kolya.co>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kolyaventuri/block/issues"
+  },
+  "homepage": "https://github.com/kolyaventuri/block#readme",
+  "devDependencies": {
+    "@types/node": "25.0.10",
+    "@types/react": "^19.2.9",
+    "@typescript-eslint/eslint-plugin": "^8.53.1",
+    "@typescript-eslint/parser": "^8.53.1",
+    "eslint": "^9.39.2",
+    "eslint-config-xo": "^0.49.0",
+    "eslint-config-xo-react": "^0.29.0",
+    "eslint-config-xo-typescript": "^9.0.0",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "react": "^19.2.3",
+    "rimraf": "^6.1.2",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18",
+    "xo": "^1.2.3"
+  },
+  "peerDependencies": {
+    "react": "^16.14.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "xo"
+    ]
+  },
+  "dependencies": {},
+  "scripts": {
+    "test": "pnpm run test:tsc && pnpm run test:lint && pnpm run test:unit",
+    "test:tsc": "tsc -p ./src -p ./test --noEmit",
+    "test:lint": "xo",
+    "test:unit": "vitest run",
+    "prebuild": "rimraf dist",
+    "build": "tsup",
+    "prepublish": "pnpm run test && pnpm run build"
+  }
+}

package/blocks.js

@@ -1,12 +0,0 @@
-var __importdefault = (this && this.__importdefault) || function (mod) {
-    return (mod && mod.__esmodule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-
-var _blocks = __importdefault(require('./lib/components')).default;
-var _blockNames = Object.keys(_blocks);
-
-for (var i = 0; i < _blockNames.length; i++) {
-  var _name = _blockNames[i];
-  exports[_name] = _blocks[_name];
-}

package/index.js

@@ -1,7 +0,0 @@
-var __importdefault = (this && this.__importdefault) || function (mod) {
-    return (mod && mod.__esmodule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-
-var renderer = __importdefault(require('./lib')).default;
-exports.default = renderer.default;

package/lib/components/block/button.js

@@ -1,27 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = __importDefault(require("react"));
-var Button = (function (_super) {
-    __extends(Button, _super);
-    function Button() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return Button;
-}(react_1.default.Component));
-exports.default = Button;

package/lib/components/block/confirmation.js

@@ -1,27 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = __importDefault(require("react"));
-var Confirmation = (function (_super) {
-    __extends(Confirmation, _super);
-    function Confirmation() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return Confirmation;
-}(react_1.default.Component));
-exports.default = Confirmation;

package/lib/components/block/image.js

@@ -1,27 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = __importDefault(require("react"));
-var Image = (function (_super) {
-    __extends(Image, _super);
-    function Image() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return Image;
-}(react_1.default.Component));
-exports.default = Image;

package/lib/components/block/text.js

@@ -1,27 +0,0 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var react_1 = __importDefault(require("react"));
-var Text = (function (_super) {
-    __extends(Text, _super);
-    function Text() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return Text;
-}(react_1.default.Component));
-exports.default = Text;