react-native-divkit 0.1.0-alpha.1

package/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+      Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,340 @@
+# react-native-divkit
+
+DivKit renderer for React Native - Server-driven UI framework.
+
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/react-native-divkit.svg)](https://www.npmjs.com/package/react-native-divkit)
+
+## Overview
+
+DivKit is a server-driven UI framework that allows you to define UI layouts in JSON and render them natively. This React Native implementation is based on the [DivKit Web](../web/divkit/) implementation, reusing the expression engine and adapting components for React Native.
+
+## Status
+
+**MVP Version 0.1.0-alpha**
+
+| Feature | Status |
+|---------|--------|
+| Text component | ✅ Complete |
+| Container component | ✅ Complete |
+| Image component | ✅ Complete |
+| State component | ✅ Complete |
+| Variable system | ✅ Complete |
+| Expression engine | ✅ Complete |
+| Action handlers | ✅ Complete |
+| Template resolution | ✅ Complete |
+
+## Installation
+
+```bash
+npm install react-native-divkit
+```
+
+### Optional Dependencies
+
+For enhanced functionality, install these optional packages:
+
+```bash
+# Optimized image loading with caching
+npm install react-native-fast-image
+
+# Gradient support (backgrounds)
+npm install react-native-linear-gradient
+
+# Clipboard support
+npm install @react-native-clipboard/clipboard
+```
+
+## Quick Start
+
+```tsx
+import { DivKit } from 'react-native-divkit';
+
+const divKitJson = {
+  card: {
+    log_id: 'hello_world',
+    states: [{
+      state_id: 0,
+      div: {
+        type: 'text',
+        text: 'Hello, @{name}!',
+        font_size: 24,
+        text_color: '#000000',
+        text_alignment_horizontal: 'center'
+      }
+    }],
+    variables: [{
+      type: 'string',
+      name: 'name',
+      value: 'World'
+    }]
+  }
+};
+
+export default function App() {
+  return (
+    <DivKit
+      data={divKitJson}
+      onStat={(stat) => console.log('Stat:', stat.type, stat.action.log_id)}
+      onCustomAction={(action) => console.log('Custom action:', action.url)}
+      onError={(error) => console.error('Error:', error.message)}
+    />
+  );
+}
+```
+
+## Components
+
+### Text
+
+```json
+{
+  "type": "text",
+  "text": "Hello World",
+  "font_size": 16,
+  "font_weight": "bold",
+  "text_color": "#000000",
+  "text_alignment_horizontal": "center",
+  "max_lines": 2
+}
+```
+
+### Container
+
+```json
+{
+  "type": "container",
+  "orientation": "vertical",
+  "items": [
+    { "type": "text", "text": "Item 1" },
+    { "type": "text", "text": "Item 2" }
+  ],
+  "content_alignment_horizontal": "center"
+}
+```
+
+### Image
+
+```json
+{
+  "type": "image",
+  "image_url": "https://example.com/image.png",
+  "scale": "fill",
+  "width": { "type": "fixed", "value": 200 },
+  "height": { "type": "fixed", "value": 150 }
+}
+```
+
+### State
+
+```json
+{
+  "type": "state",
+  "id": "my_state",
+  "default_state_id": "state1",
+  "states": [
+    {
+      "state_id": "state1",
+      "div": { "type": "text", "text": "State 1" }
+    },
+    {
+      "state_id": "state2",
+      "div": { "type": "text", "text": "State 2" }
+    }
+  ]
+}
+```
+
+## Variables
+
+Define variables in your JSON:
+
+```json
+{
+  "card": {
+    "variables": [
+      { "type": "string", "name": "userName", "value": "World" },
+      { "type": "integer", "name": "counter", "value": 0 },
+      { "type": "color", "name": "textColor", "value": "#FF0000" },
+      { "type": "boolean", "name": "isActive", "value": true }
+    ]
+  }
+}
+```
+
+Use variables in expressions:
+
+```json
+{
+  "type": "text",
+  "text": "Hello, @{userName}!",
+  "text_color": "@{textColor}"
+}
+```
+
+### Variable Types
+
+| Type | Description | Example |
+|------|-------------|---------|
+| `string` | Text value | `"Hello"` |
+| `integer` | Whole number | `42` |
+| `number` | Decimal number | `3.14` |
+| `boolean` | True/false | `true` |
+| `color` | Color value | `"#FF5500"` |
+| `url` | URL string | `"https://..."` |
+| `dict` | Key-value object | `{"key": "value"}` |
+| `array` | List of values | `[1, 2, 3]` |
+
+## Actions
+
+Actions are triggered by user interaction:
+
+```json
+{
+  "type": "text",
+  "text": "Tap me",
+  "actions": [{
+    "log_id": "button_tap",
+    "url": "divkit://custom_action"
+  }]
+}
+```
+
+### Typed Actions
+
+#### set_variable
+
+```json
+{
+  "typed": {
+    "type": "set_variable",
+    "variable_name": "counter",
+    "value": { "type": "integer", "value": 10 }
+  }
+}
+```
+
+#### set_state
+
+```json
+{
+  "typed": {
+    "type": "set_state",
+    "state_id": "my_state",
+    "temporary_state_id": "state2"
+  }
+}
+```
+
+## Props
+
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `data` | `DivJson` | Yes | DivKit JSON data |
+| `onStat` | `(stat) => void` | No | Statistics callback |
+| `onCustomAction` | `(action) => void` | No | Custom action handler |
+| `onError` | `(error) => void` | No | Error handler |
+| `direction` | `'ltr' \| 'rtl'` | No | Text direction (default: `'ltr'`) |
+| `platform` | `'desktop' \| 'touch'` | No | Platform type (default: `'touch'`) |
+| `style` | `ViewStyle` | No | Container style |
+
+## Hooks
+
+For advanced usage, you can use hooks directly:
+
+```tsx
+import {
+  useDivKitContext,
+  useVariable,
+  useVariableState,
+  useAction
+} from 'react-native-divkit';
+
+function MyComponent() {
+  const { setVariable } = useDivKitContext();
+  const counter = useVariable('counter');
+
+  return (
+    <View>
+      <Text>Count: {counter}</Text>
+      <Button
+        onPress={() => setVariable('counter', counter + 1)}
+        title="Increment"
+      />
+    </View>
+  );
+}
+```
+
+## Examples
+
+See the [examples/BasicExample](examples/BasicExample/) directory for a complete React Native app demonstrating all features.
+
+```bash
+cd examples/BasicExample
+npm install
+npm run ios   # or npm run android
+```
+
+## Documentation
+
+- [API Reference](docs/API.md) - Complete API documentation
+- [Migration Guide](docs/MIGRATION.md) - Migrating from Web version
+- [Architecture](docs/ARCHITECTURE.md) - Internal architecture
+
+## Not Included in MVP
+
+The following features are planned for future versions:
+
+- Gallery, Pager, Slider, Tabs
+- Input, Select, Switch
+- Video, Lottie animations
+- Text ranges, complex gradients
+- Advanced transitions and animations
+- Custom components API
+
+## Architecture
+
+This library is based on DivKit Web (TypeScript + Svelte):
+
+| Component | Reuse |
+|-----------|-------|
+| Expression engine | 100% copied |
+| Type definitions | 100% copied |
+| Utilities | ~90% adapted |
+| Components | ~20% (rewritten for RN) |
+| Context system | New (React-specific) |
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build PEG parser
+npm run build:peggy
+
+# Type check
+npm run typecheck
+
+# Lint
+npm run lint
+
+# Build
+npm run build
+
+# Test
+npm test
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## License
+
+Apache 2.0

package/dist/DivKit.d.ts

@@ -0,0 +1,68 @@
+/**
+ * DivKit - Main entry point component for React Native
+ *
+ * Based on Root.svelte from Web implementation
+ * Provides context setup, variable management, and component rendering
+ *
+ * MVP Scope:
+ * - 4 basic components (Text, Container, Image, State)
+ * - Variable system with reactive updates
+ * - Action execution
+ * - Template resolution
+ *
+ * Deferred for post-MVP:
+ * - Timers
+ * - Variable triggers
+ * - Complex animations
+ * - Custom components
+ * - Extensions
+ */
+import React from 'react';
+import { type ViewStyle } from 'react-native';
+import type { Action, DivJson, Direction } from '../typings/common';
+import { type WrappedError } from './utils/wrapError';
+/**
+ * Callback for logging statistics
+ */
+export type StatCallback = (stat: {
+    type: string;
+    action: Action;
+}) => void;
+/**
+ * Callback for custom actions (actions with URLs)
+ */
+export type CustomActionCallback = (action: Action & {
+    url: string;
+}) => void;
+/**
+ * Callback for errors
+ */
+export type ErrorCallback = (error: WrappedError) => void;
+/**
+ * Props for DivKit component
+ */
+export interface DivKitProps {
+    /** DivKit JSON data */
+    data: Partial<DivJson>;
+    /** Callback for statistics/logging */
+    onStat?: StatCallback;
+    /** Callback for custom actions */
+    onCustomAction?: CustomActionCallback;
+    /** Callback for errors */
+    onError?: ErrorCallback;
+    /** Text direction (default: 'ltr') */
+    direction?: Direction;
+    /** Platform type (default: 'touch' for mobile) */
+    platform?: 'desktop' | 'touch';
+    /** Custom style for the root container */
+    style?: ViewStyle;
+    /** Component ID (for debugging) */
+    id?: string;
+}
+/**
+ * DivKit - Main component
+ *
+ * Renders DivKit JSON as React Native components
+ */
+export declare function DivKit({ data, onStat, onCustomAction, onError, direction, platform, style, id }: DivKitProps): React.JSX.Element;
+//# sourceMappingURL=DivKit.d.ts.map

package/dist/DivKit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DivKit.d.ts","sourceRoot":"","sources":["../src/DivKit.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAuC,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAoB,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAe,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAUjF,OAAO,EAAa,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAOjE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAClB,KAAK,IAAI,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,KAAK,IAAI,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,uBAAuB;IACvB,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAEvB,sCAAsC;IACtC,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB,kCAAkC;IAClC,cAAc,CAAC,EAAE,oBAAoB,CAAC;IAEtC,0BAA0B;IAC1B,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB,sCAAsC;IACtC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAE/B,0CAA0C;IAC1C,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB,mCAAmC;IACnC,EAAE,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,EACnB,IAAI,EACJ,MAAM,EACN,cAAc,EACd,OAAO,EACP,SAAiB,EACjB,QAAkB,EAClB,KAAK,EACL,EAAW,EACd,EAAE,WAAW,qBAmbb"}