reactivated 0.25.0 → 1.0.0

package/src/forms/widgets.tsx

@@ -0,0 +1,85 @@
+import React from "react";
+import {Types} from "../generated";
+
+export type CoreWidget = Types["Widget"];
+
+type Optgroup = Types["Optgroup"];
+
+export const CheckboxInput = (props: {
+    name: string;
+    className?: string;
+    value: true | false;
+    onChange: (value: boolean) => void;
+}) => {
+    return (
+        <input
+            type="checkbox"
+            name={props.name}
+            className={props.className}
+            checked={props.value}
+            onChange={(event) => props.onChange(event.target.checked)}
+        />
+    );
+};
+
+export const TextInput = (props: {
+    name: string;
+    className?: string;
+    value: string | null;
+    onChange: (value: string) => void;
+}) => {
+    return (
+        <input
+            type="text"
+            name={props.name}
+            className={props.className}
+            value={props.value ?? ""}
+            onChange={(event) => props.onChange(event.target.value)}
+        />
+    );
+};
+
+export const Select = (props: {
+    name: string;
+    className?: string;
+    value: string | number | null;
+    optgroups: Optgroup[];
+    onChange: (value: string) => void;
+}) => {
+    const {name, optgroups, value} = props;
+
+    return (
+        <select
+            key={name}
+            name={name}
+            className={props.className}
+            value={value ?? ""}
+            onChange={(event) => props.onChange(event.target.value)}
+        >
+            {optgroups.map((optgroup) => {
+                const optgroupValue = (optgroup[1][0].value ?? "").toString();
+                return (
+                    <option key={optgroupValue} value={optgroupValue}>
+                        {optgroup[1][0].label}
+                    </option>
+                );
+            })}
+        </select>
+    );
+};
+
+export const Textarea = (props: {
+    name: string;
+    className?: string;
+    value: string | null;
+    onChange: (value: string) => void;
+}) => {
+    return (
+        <textarea
+            name={props.name}
+            className={props.className}
+            value={props.value ?? ""}
+            onChange={(event) => props.onChange(event.target.value)}
+        />
+    );
+};

package/src/generated.tsx

@@ -0,0 +1,267 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Types {
+  Widget:
+    | DjangoFormsWidgetsHiddenInput
+    | DjangoFormsWidgetsTextInput
+    | DjangoFormsWidgetsNumberInput
+    | DjangoFormsWidgetsURLInput
+    | DjangoFormsWidgetsTimeInput
+    | DjangoFormsWidgetsDateInput
+    | DjangoFormsWidgetsCheckboxInput
+    | DjangoFormsWidgetsPasswordInput
+    | DjangoFormsWidgetsEmailInput
+    | DjangoFormsWidgetsTextarea
+    | DjangoFormsWidgetsSelect
+    | DjangoFormsWidgetsSelectMultiple
+    | DjangoFormsWidgetsClearableFileInput
+    | DjangoFormsWidgetsSelectDateWidget
+    | DjangoFormsWidgetsSplitDateTimeWidget;
+  Optgroup: [null, [ReactivatedTypesOptgroupMember], number];
+  URLSchema: {
+    [k: string]: ReactivatedTypesURL;
+  };
+}
+export interface DjangoFormsWidgetsHiddenInput {
+  template_name: "django/forms/widgets/hidden.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsBaseWidgetAttrs;
+  type: "hidden";
+  tag: "django.forms.widgets.HiddenInput";
+}
+export interface ReactivatedSerializationWidgetsBaseWidgetAttrs {
+  id: string;
+  disabled?: boolean;
+  required?: boolean;
+  placeholder?: string;
+}
+export interface DjangoFormsWidgetsTextInput {
+  template_name: "django/forms/widgets/text.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsMaxLengthAttrs;
+  type: "text";
+  tag: "django.forms.widgets.TextInput";
+}
+export interface ReactivatedSerializationWidgetsMaxLengthAttrs {
+  id: string;
+  disabled?: boolean;
+  required?: boolean;
+  placeholder?: string;
+  maxlength?: string;
+}
+export interface DjangoFormsWidgetsNumberInput {
+  template_name: "django/forms/widgets/number.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsStepAttrs;
+  type: "number";
+  tag: "django.forms.widgets.NumberInput";
+}
+export interface ReactivatedSerializationWidgetsStepAttrs {
+  id: string;
+  disabled?: boolean;
+  required?: boolean;
+  placeholder?: string;
+  step?: string;
+}
+export interface DjangoFormsWidgetsURLInput {
+  template_name: "django/forms/widgets/url.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsMaxLengthAttrs;
+  type: "url";
+  tag: "django.forms.widgets.URLInput";
+}
+export interface DjangoFormsWidgetsTimeInput {
+  template_name: "django/forms/widgets/time.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsTimeAttrs;
+  type: "text";
+  tag: "django.forms.widgets.TimeInput";
+}
+export interface ReactivatedSerializationWidgetsTimeAttrs {
+  id: string;
+  disabled?: boolean;
+  required?: boolean;
+  placeholder?: string;
+  format?: string;
+}
+export interface DjangoFormsWidgetsDateInput {
+  template_name: "django/forms/widgets/date.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsDateAttrs;
+  type: "text";
+  tag: "django.forms.widgets.DateInput";
+}
+export interface ReactivatedSerializationWidgetsDateAttrs {
+  id: string;
+  disabled?: boolean;
+  required?: boolean;
+  placeholder?: string;
+  format?: string;
+}
+export interface DjangoFormsWidgetsCheckboxInput {
+  template_name: "django/forms/widgets/checkbox.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: boolean;
+  attrs: ReactivatedSerializationWidgetsCheckAttrs;
+  type: "checkbox";
+  tag: "django.forms.widgets.CheckboxInput";
+}
+export interface ReactivatedSerializationWidgetsCheckAttrs {
+  id: string;
+  disabled?: boolean;
+  required?: boolean;
+  placeholder?: string;
+  checked?: boolean;
+}
+export interface DjangoFormsWidgetsPasswordInput {
+  template_name: "django/forms/widgets/password.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsBaseWidgetAttrs;
+  type: "password";
+  tag: "django.forms.widgets.PasswordInput";
+}
+export interface DjangoFormsWidgetsEmailInput {
+  template_name: "django/forms/widgets/email.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsBaseWidgetAttrs;
+  type: "email";
+  tag: "django.forms.widgets.EmailInput";
+}
+export interface DjangoFormsWidgetsTextarea {
+  template_name: "django/forms/widgets/textarea.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsTextareaAttrs;
+  tag: "django.forms.widgets.Textarea";
+}
+export interface ReactivatedSerializationWidgetsTextareaAttrs {
+  id: string;
+  disabled?: boolean;
+  required?: boolean;
+  placeholder?: string;
+  cols: string;
+  rows: string;
+}
+export interface DjangoFormsWidgetsSelect {
+  template_name: "django/forms/widgets/select.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsBaseWidgetAttrs;
+  optgroups: [null, [ReactivatedSerializationWidgetsOptgroupMember], number][];
+  tag: "django.forms.widgets.Select";
+}
+export interface ReactivatedSerializationWidgetsOptgroupMember {
+  name: string;
+  value: string | number | boolean | null;
+  label: string;
+  selected: boolean;
+}
+export interface DjangoFormsWidgetsSelectMultiple {
+  template_name: "django/forms/widgets/select.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string[];
+  attrs: ReactivatedSerializationWidgetsSelectMultipleAttrs;
+  optgroups: [null, [ReactivatedSerializationWidgetsOptgroupMember], number][];
+  tag: "django.forms.widgets.SelectMultiple";
+}
+export interface ReactivatedSerializationWidgetsSelectMultipleAttrs {
+  id: string;
+  disabled?: boolean;
+  required?: boolean;
+  placeholder?: string;
+  multiple: boolean;
+}
+export interface DjangoFormsWidgetsClearableFileInput {
+  template_name: "django/forms/widgets/clearable_file_input.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: string | null;
+  attrs: ReactivatedSerializationWidgetsBaseWidgetAttrs;
+  type: "file";
+  checkbox_name: string;
+  checkbox_id: string;
+  is_initial: boolean;
+  input_text: string;
+  initial_text: string;
+  clear_checkbox_label: string;
+  tag: "django.forms.widgets.ClearableFileInput";
+}
+export interface DjangoFormsWidgetsSelectDateWidget {
+  template_name: "django/forms/widgets/select_date.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: unknown;
+  attrs: ReactivatedSerializationWidgetsBaseWidgetAttrs;
+  _reactivated_value_do_not_use?: {
+    year: string | null;
+    month: string | null;
+    day: string | null;
+  };
+  subwidgets: [DjangoFormsWidgetsSelect, DjangoFormsWidgetsSelect, DjangoFormsWidgetsSelect];
+  tag: "django.forms.widgets.SelectDateWidget";
+}
+export interface DjangoFormsWidgetsSplitDateTimeWidget {
+  template_name: "django/forms/widgets/splitdatetime.html";
+  name: string;
+  is_hidden: boolean;
+  required: boolean;
+  value: unknown;
+  attrs: ReactivatedSerializationWidgetsBaseWidgetAttrs;
+  _reactivated_value_do_not_use?: {
+    "0": string | null;
+    "1": string | null;
+  };
+  subwidgets: [DjangoFormsWidgetsDateInput, DjangoFormsWidgetsTimeInput];
+  tag: "django.forms.widgets.SplitDateTimeWidget";
+}
+export interface ReactivatedTypesOptgroupMember {
+  name: string;
+  value: string | number | boolean | null;
+  label: string;
+  selected: boolean;
+}
+export interface ReactivatedTypesURL {
+  route: string;
+  args: {
+    [k: string]: string;
+  };
+}

package/src/generator/constants.tsx

@@ -0,0 +1,40 @@
+#!/usr/bin/env node
+
+import fs from "fs";
+
+// Must be above the compile import as get-stdin used by
+// json-schema-to-typescript messes up the descriptor even if unused.
+const stdinBuffer = fs.readFileSync(0);
+
+import {
+    Project,
+    SourceFile,
+    StructureKind,
+    SyntaxKind,
+    VariableDeclarationKind,
+    WriterFunction,
+    Writers,
+} from "ts-morph";
+
+const schema = JSON.parse(stdinBuffer.toString("utf8"));
+
+const project = new Project();
+
+const interfaces = project.createSourceFile("");
+
+const {urls, templates, types, values} = schema;
+
+for (const name of Object.keys(values)) {
+    interfaces.addVariableStatement({
+        declarationKind: VariableDeclarationKind.Const,
+        isExported: true,
+        declarations: [
+            {
+                name,
+                initializer: Writers.assertion(JSON.stringify(values[name]), "const"),
+            },
+        ],
+    });
+}
+
+process.stdout.write(interfaces.getText());

package/src/generator.tsx

@@ -0,0 +1,181 @@
+#!/usr/bin/env node
+
+import fs from "fs";
+import * as generated from "./generated";
+
+// Must be above the compile import as get-stdin used by
+// json-schema-to-typescript messes up the descriptor even if unused.
+const stdinBuffer = fs.readFileSync(0);
+
+import {compile} from "json-schema-to-typescript";
+import {
+    Project,
+    SourceFile,
+    StructureKind,
+    SyntaxKind,
+    VariableDeclarationKind,
+    WriterFunction,
+    Writers,
+} from "ts-morph";
+
+const schema = JSON.parse(stdinBuffer.toString("utf8"));
+const {urls: possibleEmptyUrls, templates, interfaces, types, values} = schema;
+
+const urls: generated.Types["URLSchema"] = {
+    ...possibleEmptyUrls,
+    __reactivated_do_not_use: {
+        route: "__reactivated_do_not_use",
+        args: {},
+    },
+    __reactivated_do_not_use_args: {
+        route: "__reactivated_do_not_use_args",
+        args: {
+            _: "string",
+        },
+    },
+};
+
+const project = new Project();
+
+const sourceFile = project.createSourceFile("");
+
+if (Object.keys(urls).length !== 0) {
+    sourceFile.addVariableStatement({
+        declarationKind: VariableDeclarationKind.Const,
+        declarations: [
+            {
+                name: "urls",
+                initializer: JSON.stringify(urls),
+            },
+        ],
+    });
+
+    const urlMap = sourceFile.addInterface({
+        name: "URLMap",
+    });
+    urlMap.setIsExported(true);
+
+    const withArguments = [""];
+    const withoutArguments = [""];
+
+    for (const name of Object.keys(urls)) {
+        const properties = urls[name as keyof typeof urls].args;
+        const normalizedName = name.replace(/[^\w]/g, "_");
+
+        const urlInterface = sourceFile.addInterface({
+            name: normalizedName,
+            properties: [{name: "name", type: `'${name}'`}],
+        });
+        const argsInterface = sourceFile.addInterface({
+            name: `${normalizedName}_args`,
+        });
+
+        for (const propertyName of Object.keys(properties)) {
+            argsInterface.addProperty({
+                name: propertyName,
+                type: properties[propertyName as keyof typeof properties],
+            });
+        }
+        urlInterface.addProperty({
+            name: "args",
+            type: `${normalizedName}_args`,
+        });
+
+        urlMap.addProperty({
+            name: normalizedName,
+            type: normalizedName,
+        });
+
+        if (Object.keys(properties).length === 0) {
+            withoutArguments.push(normalizedName);
+        } else {
+            withArguments.push(normalizedName);
+        }
+    }
+    sourceFile.addTypeAlias({name: "WithArguments", type: withArguments.join("|")});
+    sourceFile.addTypeAlias({
+        name: "WithoutArguments",
+        type: withoutArguments.join("|"),
+    });
+    sourceFile.addStatements(`
+
+    type All = WithArguments|WithoutArguments;
+    export function reverse<T extends WithoutArguments['name']>(name: T): string;
+    export function reverse<T extends WithArguments['name']>(name: T, args: Extract<WithArguments, {name: T}>['args']): string;
+    export function reverse<T extends All['name']>(name: T, args?: Extract<WithArguments, {name: T}>['args']): string {
+        let route = urls[name].route;
+
+        if (args != null) {
+            for (const token of Object.keys(args)) {
+                route = route.replace(new RegExp('<(.+?:)' + token + '>'), (args as any)[token]);
+            }
+        }
+        return route;
+    }`);
+}
+
+sourceFile.addStatements(`
+import React from "react"
+import createContext from "reactivated/dist/context";
+import * as forms from "reactivated/dist/forms";
+import * as generated from "reactivated/dist/generated";
+
+// Note: this needs strict function types to behave correctly with excess properties etc.
+export type Checker<P, U extends (React.FunctionComponent<P> | React.ComponentClass<P>)> = {};
+
+export const {Context, Provider, getServerData} = createContext<_Types["Context"]>();
+
+export const getTemplate = ({template_name}: {template_name: string}) => {
+    // This require needs to be *inside* the function to avoid circular dependencies with esbuild.
+    const { default: templates, filenames } = require('../../client/templates/**/*');
+    const templatePath = "../../client/templates/" + template_name + ".tsx";
+    const possibleTemplate: {default: React.ComponentType<any>} | null = templates.find((t: any, index: number) => filenames[index] === templatePath);
+
+    if (possibleTemplate == null) {
+        throw new Error("Template " + template_name + ".tsx not found");
+    }
+    return possibleTemplate.default;
+}
+
+export const CSRFToken = forms.createCSRFToken(Context);
+
+export const {createRenderer, Iterator} = forms.bindWidgetType<_Types["globals"]["Widget"]>();
+export type FieldHandler = forms.FieldHandler<_Types["globals"]["Widget"]>;
+
+export const {Form, FormSet, Widget, useForm, useFormSet, ManagementForm} = forms;
+`);
+
+// tslint:disable-next-line
+compile(types, "_Types").then((ts) => {
+    process.stdout.write("/* eslint-disable */\n");
+    process.stdout.write(ts);
+
+    for (const name of Object.keys(templates)) {
+        const propsName = templates[name];
+        sourceFile.addStatements(`
+
+import ${name}Implementation from "@client/templates/${name}"
+export type ${name}Check = Checker<_Types["${propsName}"], typeof ${name}Implementation>;
+
+export namespace templates {
+    export type ${name} = _Types["${propsName}"];
+}
+
+
+        `);
+    }
+
+    for (const name of Object.keys(interfaces)) {
+        const propsName = interfaces[name];
+        sourceFile.addStatements(`
+
+export namespace interfaces {
+    export type ${name} = _Types["${propsName}"];
+}
+
+
+        `);
+    }
+
+    process.stdout.write(sourceFile.getText());
+});

package/src/index.tsx

@@ -0,0 +1,4 @@
+import React from "react";
+
+export * from "./components/Form";
+export * from "./components/Widget";

package/src/models.tsx

@@ -0,0 +1,12 @@
+export interface Settings {
+    DEBUG_PORT: number;
+    MEDIA_URL: string;
+    STATIC_URL: string;
+    DEBUG: boolean;
+}
+
+export interface Message {
+    level: number;
+    level_tag: "info" | "success" | "error" | "warning" | "debug";
+    message: string;
+}