code-battles 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import React from 'react';
+import { DayOfWeek } from '@mantine/dates';
+import { Auth } from 'firebase/auth';
+import { Firestore } from 'firebase/firestore';
+
+interface CodeBattlesRequiredConfiguration {
+    firebase: any;
+    maps: string[];
+}
+interface CodeBattlesDatesConfiguration {
+    locale?: string;
+    firstDayOfWeek?: DayOfWeek;
+    weekendDays?: DayOfWeek[];
+    timezone?: string;
+}
+interface CodeBattlesOptionalConfiguration {
+    primaryColor: string;
+    admin: string;
+    title: string;
+    firestore: Firestore;
+    authentication: Auth;
+    runningCountOptions?: number[];
+    dates?: CodeBattlesDatesConfiguration;
+}
+interface CodeBattlesConfiguration extends CodeBattlesRequiredConfiguration, Partial<CodeBattlesOptionalConfiguration> {
+}
+
+interface Props$1 {
+    blocks?: React.ReactNode;
+    routes: Record<string, React.ReactNode>;
+    configuration: CodeBattlesConfiguration;
+}
+declare const CodeBattles: React.FC<Props$1>;
+
+interface Props extends React.PropsWithChildren {
+    title: string;
+    logo: string;
+    inline?: boolean;
+}
+declare const Block: React.FC<Props>;
+
+declare const initialize: () => void;
+
+export { Block, CodeBattles, type CodeBattlesConfiguration, initialize };

package/dist/pdoc-template/custom.css

@@ -0,0 +1,22 @@
+@media (prefers-color-scheme: dark) {
+  :root {
+    --pdoc-background: #212529;
+  }
+
+  .pdoc {
+    --text: #f7f7f7;
+    --muted: #9d9d9d;
+    --link: #58a6ff;
+    --link-hover: #3989ff;
+    --code: #333;
+    --active: #555;
+
+    --accent: #343434;
+    --accent2: #555;
+
+    --nav-hover: rgba(0, 0, 0, 0.1);
+    --name: #77c1ff;
+    --def: #0cdd0c;
+    --annotation: #00c037;
+  }
+}

package/dist/pdoc-template/module.html.jinja2

@@ -0,0 +1,306 @@
+{% extends "frame.html.jinja2" %}
+{% block title %}{{ module.modulename }} API documentation{% endblock %}
+{% block nav %}
+    {% block module_list_link %}
+        {% set parentmodule = ".".join(module.modulename.split(".")[:-1]) %}
+        {% if parentmodule and parentmodule in all_modules %}
+            <a class="pdoc-button module-list-button" href="../{{ parentmodule.split(".")[-1] }}.html">
+                {% include "resources/box-arrow-in-left.svg" %}
+                &nbsp;
+                {{- parentmodule -}}
+            </a>
+        {% elif not root_module_name %}
+            <a class="pdoc-button module-list-button" href="{{ "../" * module.modulename.count(".") }}index.html">
+                {% include "resources/box-arrow-in-left.svg" %}
+                &nbsp;
+                Module Index
+            </a>
+        {% endif %}
+    {% endblock %}
+
+    {% block nav_title %}
+        {% if logo %}
+            {% if logo_link %}<a href="{{ logo_link }}">{% endif %}
+            <img src="{{ logo }}" class="logo" alt="project logo"/>
+            {% if logo_link %}</a>{% endif %}
+        {% endif %}
+    {% endblock %}
+
+    {% block search_box %}
+        {% if search and all_modules|length > 1 %}
+            {# we set a pattern here so that we can use the :valid CSS selector #}
+            <input type="search" placeholder="Search..." role="searchbox" aria-label="search"
+                   pattern=".+" required>
+        {% endif %}
+    {% endblock %}
+
+    {% block nav_index %}
+        {% set index = module.docstring | to_markdown | to_html | attr("toc_html") %}
+        {% if index %}
+            <h2>Contents</h2>
+            {{ index | safe }}
+        {% endif %}
+    {% endblock %}
+
+    {% block nav_submodules %}
+        {% if module.submodules %}
+            <h2>Submodules</h2>
+            <ul>
+                {% for submodule in module.submodules if is_public(submodule) | trim %}
+                    <li>{{ submodule.taken_from | link(text=submodule.name) }}</li>
+                {% endfor %}
+            </ul>
+        {% endif %}
+    {% endblock %}
+
+    {% block nav_members %}
+        {% if module.members %}
+            <h2>API Documentation</h2>
+            {{ nav_members(module.members.values()) }}
+        {% endif %}
+    {% endblock %}
+
+    {% block nav_footer %}
+        {% if footer_text %}
+            <footer>{{ footer_text }}</footer>
+        {% endif %}
+    {% endblock %}
+
+    {% block attribution %}
+        <a class="attribution" title="pdoc: Python API documentation generator" href="https://pdoc.dev" target="_blank">
+            built with <span class="visually-hidden">pdoc</span><img
+                alt="pdoc logo"
+                src="data:image/svg+xml,
+                        {%- filter urlencode %}{% include "resources/pdoc-logo.svg" %}{% endfilter %}"/>
+        </a>
+    {% endblock %}
+{% endblock nav %}
+{% block content %}
+    <main class="pdoc">
+        {% block module_info %}
+            <section class="module-info">
+                {% block edit_button %}
+                    {% if edit_url %}
+                        {% if "github.com" in edit_url %}
+                            {% set edit_text = "Edit on GitHub" %}
+                        {% elif "gitlab" in edit_url %}
+                            {% set edit_text = "Edit on GitLab" %}
+                        {% else %}
+                            {% set edit_text = "Edit Source" %}
+                        {% endif %}
+                        <a class="pdoc-button git-button" href="{{ edit_url }}">{{ edit_text }}</a>
+                    {% endif %}
+                {% endblock %}
+                <h1 class="modulename">Code Battles API</h1>
+                {{ docstring(module) }}
+                {{ view_source_state(module) }}
+                {{ view_source_button(module) }}
+                {{ view_source_code(module) }}
+            </section>
+        {% endblock %}
+        {% block module_contents %}
+            {% for m in module.flattened_own_members if is_public(m) | trim %}
+                <section id="{{ m.qualname or m.name }}">
+                    {{ member(m) }}
+                    {% if m.kind == "class" %}
+                        {% for m in m.own_members if m.kind != "class" and is_public(m) | trim %}
+                            <div id="{{ m.qualname }}" class="classattr">
+                                {{ member(m) }}
+                            </div>
+                        {% endfor %}
+                        {% set inherited_members = inherited(m) | trim %}
+                        {% if inherited_members %}
+                            <div class="inherited">
+                                <h5>Inherited Members</h5>
+                                <dl>
+                                    {{ inherited_members }}
+                                </dl>
+                            </div>
+                        {% endif %}
+                    {% endif %}
+                </section>
+            {% endfor %}
+        {% endblock %}
+    </main>
+    {% if mtime %}
+        {% include "livereload.html.jinja2" %}
+    {% endif %}
+    {% block search_js %}
+        {% if search and all_modules|length > 1 %}
+            {% include "search.html.jinja2" %}
+        {% endif %}
+    {% endblock %}
+{% endblock content %}
+{#
+End of content, beginning of helper macros.
+See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an explanation of defaultmacro.
+#}
+{% defaultmacro bases(cls) %}
+    {%- if cls.bases -%}
+        <wbr>(
+        {%- for base in cls.bases -%}
+            <span class="base">{{ base[:2] | link(text=base[2]) }}</span>
+            {%- if loop.nextitem %}, {% endif %}
+        {%- endfor -%}
+        )
+    {%- endif -%}
+{% enddefaultmacro %}
+{% defaultmacro default_value(var) -%}
+    {%- if var.default_value_str %}
+        =
+        {% if var.default_value_str | length > 100 -%}
+            <input id="{{ var.qualname }}-view-value" class="view-value-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
+            <label class="view-value-button pdoc-button" for="{{ var.qualname }}-view-value"></label>
+        {%- endif -%}
+        <span class="default_value">{{ var.default_value_str | escape | linkify }}</span>
+    {%- endif -%}
+{% enddefaultmacro %}
+{% defaultmacro annotation(var) %}
+    {%- if var.annotation_str -%}
+        <span class="annotation">{{ var.annotation_str | escape | linkify }}</span>
+    {%- endif -%}
+{% enddefaultmacro %}
+{% defaultmacro decorators(doc) %}
+    {% for d in doc.decorators if not d.startswith("@_") %}
+        <div class="decorator">{{ d }}</div>
+    {% endfor %}
+{% enddefaultmacro %}
+{% defaultmacro function(fn) -%}
+    {{ decorators(fn) }}
+    {% if fn.name == "__init__" %}
+        <span class="name">{{ ".".join(fn.qualname.split(".")[:-1]) }}</span>
+        {{- fn.signature_without_self | format_signature(colon=False) | linkify }}
+    {% else %}
+        <span class="def">{{ fn.funcdef }}</span>
+        <span class="name">{{ fn.name }}</span>
+        {{- fn.signature | format_signature(colon=True) | linkify }}
+    {% endif %}
+{% enddefaultmacro %}
+{% defaultmacro variable(var) -%}
+    <span class="name">{{ var.name }}</span>{{ annotation(var) }}{{ default_value(var) }}
+{% enddefaultmacro %}
+{% defaultmacro submodule(mod) -%}
+    <span class="name">{{ mod.taken_from | link }}</span>
+{% enddefaultmacro %}
+{% defaultmacro class(cls) -%}
+    {{ decorators(cls) }}
+    <span class="def">class</span>
+    <span class="name">{{ cls.qualname }}</span>
+    {{- bases(cls) -}}:
+{% enddefaultmacro %}
+{% defaultmacro member(doc) %}
+    {{- view_source_state(doc) -}}
+    <div class="attr {{ doc.kind }}">
+        {% if doc.kind == "class" %}
+            {{ class(doc) }}
+        {% elif doc.kind == "function" %}
+            {{ function(doc) }}
+        {% elif doc.kind == "module" %}
+            {{ submodule(doc) }}
+        {% else %}
+            {{ variable(doc) }}
+        {% endif %}
+        {{ view_source_button(doc) }}
+    </div>
+    <a class="headerlink" href="#{{ doc.qualname or doc.name }}"></a>
+    {{ view_source_code(doc) }}
+    {{ docstring(doc) }}
+{% enddefaultmacro %}
+{% defaultmacro docstring(var) %}
+    {% if var.docstring %}
+        <div class="docstring">{{ var.docstring | to_markdown | to_html | linkify(namespace=var.qualname) }}</div>
+    {% endif %}
+{% enddefaultmacro %}
+{% defaultmacro nav_members(members) %}
+    <ul class="memberlist">
+        {% for m in members if is_public(m) | trim %}
+            <li>
+                {% if m.kind == "class" %}
+                    <a class="class" href="#{{ m.qualname }}">{{ m.qualname }}</a>
+                    {% if m.own_members %}
+                        {{ nav_members(m.own_members) | indent(12) }}
+                    {% endif %}
+                {% elif m.kind == "module" %}
+                    <a class="module" href="#{{ m.name }}">{{ m.name }}</a>
+                {% elif m.name == "__init__" %}
+                    <a class="function" href="#{{ m.qualname }}">{{ m.qualname.split(".")[-2] }}</a>
+                {% else %}
+                    <a class="{{ m.kind }}" href="#{{ m.qualname }}">{{ m.name }}</a>
+                {% endif %}
+            </li>
+        {% endfor %}
+    </ul>
+{% enddefaultmacro %}
+{% defaultmacro is_public(doc) %}
+    {#
+    This macro is a bit unconventional in that its output is not rendered, but treated as a boolean:
+    Returning no text is interpreted as false, returning any other text is iterpreted as true.
+    Implementing this as a macro makes it very easy to override with a custom template, see
+    https://github.com/mitmproxy/pdoc/tree/main/examples/custom-template.
+    #}
+    {% if doc.name == "__init__" and (doc.docstring or (doc.kind == "function" and doc.signature_without_self.parameters)) %}
+        {# show constructors that have a docstring or at least one extra argument #}
+        true
+    {% elif doc.name == "__doc__" %}
+        {# We don't want to document __doc__ itself, https://github.com/mitmproxy/pdoc/issues/235 #}
+    {% elif doc.kind == "module" and doc.fullname not in all_modules %}
+        {# Skip modules that were manually excluded, https://github.com/mitmproxy/pdoc/issues/334 #}
+    {% elif (doc.qualname or doc.name) is in(module.obj.__all__ or []) %}
+        {# members starting with an underscore are still public if mentioned in __all__ #}
+        true
+    {% elif not doc.name.startswith("_") and (doc.kind != "variable" or doc.is_enum_member or doc.docstring) %}
+        {# members not starting with an underscore are considered public by default #}
+        true
+    {% endif %}
+{% enddefaultmacro %}
+{# fmt: off #}
+{% defaultmacro inherited(cls) %}
+    {% for base, members in cls.inherited_members.items() %}
+        {% set m = None %}{# workaround for https://github.com/pallets/jinja/issues/1427 #}
+        {% set member_html %}
+            {% for m in members if is_public(m) | trim %}
+                <dd id="{{ m.qualname }}" class="{{ m.kind }}">
+                    {{- m.taken_from | link(text=m.name.replace("__init__",base[1])) -}}
+                </dd>
+            {% endfor %}
+        {% endset %}
+        {# we may not have any public members, in which case we don't want to print anything. #}
+        {% if member_html %}
+            <div><dt>{{ base | link }}</dt>
+                {{ member_html }}
+            </div>
+        {% endif %}
+    {% endfor %}
+{% enddefaultmacro %}
+{# fmt: on #}
+{% defaultmacro view_source_state(doc) %}
+    {% if show_source and doc.source %}
+        <input id="{{ doc.qualname or "mod-" + doc.name }}-view-source" class="view-source-toggle-state" type="checkbox" aria-hidden="true" tabindex="-1">
+    {% endif %}
+{% enddefaultmacro %}
+{% defaultmacro view_source_button(doc) %}
+    {% if show_source and doc.source %}
+        <label class="view-source-button" for="{{ doc.qualname or "mod-" + doc.name }}-view-source"><span>View Source</span></label>
+    {% endif %}
+{% enddefaultmacro %}
+{% defaultmacro view_source_code(doc) %}
+    {% if show_source and doc.source %}
+        {{ doc | highlight }}
+    {% endif %}
+{% enddefaultmacro %}
+{% defaultmacro module_name() %}
+    <h1 class="modulename">
+        {% set parts = module.modulename.split(".") %}
+        {% for part in parts %}
+            {%- set fullname = ".".join(parts[:loop.index]) -%}
+            {%- if fullname in all_modules and fullname != module.modulename -%}
+                <a href="./{{ "../" * loop.revindex0 }}{{ part }}.html">{{ part }}</a>
+            {%- else -%}
+                {{ part }}
+            {%- endif -%}
+            {%- if loop.nextitem -%}
+                <wbr>.
+            {%- endif -%}
+        {% endfor %}
+    </h1>
+{% enddefaultmacro %}

package/dist/pdoc-template/syntax-highlighting.css

@@ -0,0 +1,248 @@
+@media (prefers-color-scheme: dark) {
+  /* monokai color scheme, see pdoc/template/README.md */
+  pre {
+    line-height: 124%;
+  }
+  span.linenos {
+    color: inherit;
+    background-color: transparent;
+    padding-left: 5px;
+    padding-right: 20px;
+  }
+  .pdoc-code .hll {
+    background-color: #49483e;
+  }
+  .pdoc-code {
+    background: #272822;
+    color: #f8f8f2;
+  }
+  .pdoc-code .c {
+    color: #75715e;
+  } /* Comment */
+  .pdoc-code .err {
+    color: #960050;
+    background-color: #1e0010;
+  } /* Error */
+  .pdoc-code .esc {
+    color: #f8f8f2;
+  } /* Escape */
+  .pdoc-code .g {
+    color: #f8f8f2;
+  } /* Generic */
+  .pdoc-code .k {
+    color: #66d9ef;
+  } /* Keyword */
+  .pdoc-code .l {
+    color: #ae81ff;
+  } /* Literal */
+  .pdoc-code .n {
+    color: #f8f8f2;
+  } /* Name */
+  .pdoc-code .o {
+    color: #f92672;
+  } /* Operator */
+  .pdoc-code .x {
+    color: #f8f8f2;
+  } /* Other */
+  .pdoc-code .p {
+    color: #f8f8f2;
+  } /* Punctuation */
+  .pdoc-code .ch {
+    color: #75715e;
+  } /* Comment.Hashbang */
+  .pdoc-code .cm {
+    color: #75715e;
+  } /* Comment.Multiline */
+  .pdoc-code .cp {
+    color: #75715e;
+  } /* Comment.Preproc */
+  .pdoc-code .cpf {
+    color: #75715e;
+  } /* Comment.PreprocFile */
+  .pdoc-code .c1 {
+    color: #75715e;
+  } /* Comment.Single */
+  .pdoc-code .cs {
+    color: #75715e;
+  } /* Comment.Special */
+  .pdoc-code .gd {
+    color: #f92672;
+  } /* Generic.Deleted */
+  .pdoc-code .ge {
+    color: #f8f8f2;
+    font-style: italic;
+  } /* Generic.Emph */
+  .pdoc-code .gr {
+    color: #f8f8f2;
+  } /* Generic.Error */
+  .pdoc-code .gh {
+    color: #f8f8f2;
+  } /* Generic.Heading */
+  .pdoc-code .gi {
+    color: #a6e22e;
+  } /* Generic.Inserted */
+  .pdoc-code .go {
+    color: #66d9ef;
+  } /* Generic.Output */
+  .pdoc-code .gp {
+    color: #f92672;
+    font-weight: bold;
+  } /* Generic.Prompt */
+  .pdoc-code .gs {
+    color: #f8f8f2;
+    font-weight: bold;
+  } /* Generic.Strong */
+  .pdoc-code .gu {
+    color: #75715e;
+  } /* Generic.Subheading */
+  .pdoc-code .gt {
+    color: #f8f8f2;
+  } /* Generic.Traceback */
+  .pdoc-code .kc {
+    color: #66d9ef;
+  } /* Keyword.Constant */
+  .pdoc-code .kd {
+    color: #66d9ef;
+  } /* Keyword.Declaration */
+  .pdoc-code .kn {
+    color: #f92672;
+  } /* Keyword.Namespace */
+  .pdoc-code .kp {
+    color: #66d9ef;
+  } /* Keyword.Pseudo */
+  .pdoc-code .kr {
+    color: #66d9ef;
+  } /* Keyword.Reserved */
+  .pdoc-code .kt {
+    color: #66d9ef;
+  } /* Keyword.Type */
+  .pdoc-code .ld {
+    color: #e6db74;
+  } /* Literal.Date */
+  .pdoc-code .m {
+    color: #ae81ff;
+  } /* Literal.Number */
+  .pdoc-code .s {
+    color: #e6db74;
+  } /* Literal.String */
+  .pdoc-code .na {
+    color: #a6e22e;
+  } /* Name.Attribute */
+  .pdoc-code .nb {
+    color: #f8f8f2;
+  } /* Name.Builtin */
+  .pdoc-code .nc {
+    color: #a6e22e;
+  } /* Name.Class */
+  .pdoc-code .no {
+    color: #66d9ef;
+  } /* Name.Constant */
+  .pdoc-code .nd {
+    color: #a6e22e;
+  } /* Name.Decorator */
+  .pdoc-code .ni {
+    color: #f8f8f2;
+  } /* Name.Entity */
+  .pdoc-code .ne {
+    color: #a6e22e;
+  } /* Name.Exception */
+  .pdoc-code .nf {
+    color: #a6e22e;
+  } /* Name.Function */
+  .pdoc-code .nl {
+    color: #f8f8f2;
+  } /* Name.Label */
+  .pdoc-code .nn {
+    color: #f8f8f2;
+  } /* Name.Namespace */
+  .pdoc-code .nx {
+    color: #a6e22e;
+  } /* Name.Other */
+  .pdoc-code .py {
+    color: #f8f8f2;
+  } /* Name.Property */
+  .pdoc-code .nt {
+    color: #f92672;
+  } /* Name.Tag */
+  .pdoc-code .nv {
+    color: #f8f8f2;
+  } /* Name.Variable */
+  .pdoc-code .ow {
+    color: #f92672;
+  } /* Operator.Word */
+  .pdoc-code .w {
+    color: #f8f8f2;
+  } /* Text.Whitespace */
+  .pdoc-code .mb {
+    color: #ae81ff;
+  } /* Literal.Number.Bin */
+  .pdoc-code .mf {
+    color: #ae81ff;
+  } /* Literal.Number.Float */
+  .pdoc-code .mh {
+    color: #ae81ff;
+  } /* Literal.Number.Hex */
+  .pdoc-code .mi {
+    color: #ae81ff;
+  } /* Literal.Number.Integer */
+  .pdoc-code .mo {
+    color: #ae81ff;
+  } /* Literal.Number.Oct */
+  .pdoc-code .sa {
+    color: #e6db74;
+  } /* Literal.String.Affix */
+  .pdoc-code .sb {
+    color: #e6db74;
+  } /* Literal.String.Backtick */
+  .pdoc-code .sc {
+    color: #e6db74;
+  } /* Literal.String.Char */
+  .pdoc-code .dl {
+    color: #e6db74;
+  } /* Literal.String.Delimiter */
+  .pdoc-code .sd {
+    color: #e6db74;
+  } /* Literal.String.Doc */
+  .pdoc-code .s2 {
+    color: #e6db74;
+  } /* Literal.String.Double */
+  .pdoc-code .se {
+    color: #ae81ff;
+  } /* Literal.String.Escape */
+  .pdoc-code .sh {
+    color: #e6db74;
+  } /* Literal.String.Heredoc */
+  .pdoc-code .si {
+    color: #e6db74;
+  } /* Literal.String.Interpol */
+  .pdoc-code .sx {
+    color: #e6db74;
+  } /* Literal.String.Other */
+  .pdoc-code .sr {
+    color: #e6db74;
+  } /* Literal.String.Regex */
+  .pdoc-code .s1 {
+    color: #e6db74;
+  } /* Literal.String.Single */
+  .pdoc-code .ss {
+    color: #e6db74;
+  } /* Literal.String.Symbol */
+  .pdoc-code .bp {
+    color: #f8f8f2;
+  } /* Name.Builtin.Pseudo */
+  .pdoc-code .fm {
+    color: #a6e22e;
+  } /* Name.Function.Magic */
+  .pdoc-code .vc {
+    color: #f8f8f2;
+  } /* Name.Variable.Class */
+  .pdoc-code .vg {
+    color: #f8f8f2;
+  } /* Name.Variable.Global */
+  .pdoc-code .vi {
+    color: #f8f8f2;
+  } /* Name.Variable.Instance */
+  .pdoc-code .vm {
+    color: #f8f8f2;
+  } /* Name.Variable.Magic */
+}