Figure this out before publishing the first release candidate so there's no major changes to the API from then on.

Related to #12.

Want flexibility in delivery e.g.:

1. can load the script in a template (either from collectstatic or from a CDN) and use it from there
   • and in this context, need to decide whether or not to add the API to window automatically (as is currently the case)
2. can install via npm and import modules/build bundles

Also want flexibility in the project type e.g.:

• TypeScript
• CommonJS modules
• ES modules

So we can handle form objects (and access their attributes e.g. errors, cleaned_data) from AJAX requests.

See https://docs.djangoproject.com/en/4.1/howto/csrf/#using-csrf-protection-with-ajax.

Implement the django.urls.reverse function in JavaScript.

Also see:
https://docs.djangoproject.com/en/4.1/topics/http/urls/#specifying-defaults-for-view-arguments

Release date: December 4, 2023
https://code.djangoproject.com/wiki/Version5.0Roadmap#schedule

It sort of implies that you would specify actual URLs rather than the path names. Maybe something like ALLOWED_URLNAMES or ALLOWED_PATHNAMES would be better?

And then the user can generate their own bundle. This would be the preferred way to use this package, and would allow users to avoid polluting the global namespace.

See:

• https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html

i.e. make this pattern possible:

class HomeView(..., TemplateView):
    def get_js_context_data(self, **kwargs):
        context = super().get_js_context_data(**kwargs)
        context["someString"] = "hi"
        return context

>> console.log(contextData.someString)
hi

https://github.com/ely-as/django-gesha/blob/main/tests/fake_project/fake/templates/test.html
⬇️
https://github.com/ely-as/django-gesha/blob/main/js_tests/test.html

Could use functools.lru_cache.

Need to test that cache is regenerated whenever something changes e.g. ROOF_URLCONF setting, the contents of urlpatterns itself etc.

See https://tsdoc.org/

Related to #13

e.g. store in folder with version string