Pixsys.Library.Scripts.ScriptInjector 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Pixsys.Library.Scripts.ScriptInjector --version 1.0.0
                    


                    

                
NuGet\Install-Package Pixsys.Library.Scripts.ScriptInjector -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Pixsys.Library.Scripts.ScriptInjector" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Pixsys.Library.Scripts.ScriptInjector" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Pixsys.Library.Scripts.ScriptInjector" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Pixsys.Library.Scripts.ScriptInjector --version 1.0.0
                    


                    

                
#r "nuget: Pixsys.Library.Scripts.ScriptInjector, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Pixsys.Library.Scripts.ScriptInjector@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Pixsys.Library.Scripts.ScriptInjector&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Pixsys.Library.Scripts.ScriptInjector&version=1.0.0
                    


                            Install as a Cake Tool

Pixsys.Library.Scripts.ScriptInjector

This middleware and IResultFilter will inject scripts or script paths to your HTML, and all your scripts tags will contain a nonce to be compliant with your content security policy.

1. Installation

1.1 Register the filter in Program.cs

You can call the AddInjectionScriptsFilter method right after AddControllersWithViews:

using Pixsys.Library.Scripts.ScriptInjector;

WebApplicationBuilder builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllersWithViews().AddInjectionScriptsFilter();

1.2 Usage

1.2.1 Registered scripts vs injected scripts

Depending on where you will set your scripts (or scripts paths), they will be registered in two differents services with a different Lifetime :

  • RegisteredScriptInjector is registered as a Singleton service.
  • ScriptInjector is registered as a scoped service.

This allows you to "pre-register" some of your scripts in Program.cs and call them only when you need them.

1.2.1 Register scripts

Set your scripts or scripts paths and specify if they must be used on all pages or not.

WebApplication app = builder.Build();

_ = app.RegisterScripts(
    [
        new Pixsys.Library.Scripts.ScriptInjector.Models.RegisteredScript { Name = "global-hello", Script = "console.log('registered Hello World on all pages');", UseOnAllPages = true },
        new Pixsys.Library.Scripts.ScriptInjector.Models.RegisteredScript { Name = "specific-hello", Script = "console.log('registered Hello World on specific pages');", UseOnAllPages = false },
    ]);    

_ = app.RegisterScriptPaths(
    [
        new Pixsys.Library.Scripts.ScriptInjector.Models.RegisteredPath { Name = "global-path-1", Path = "<FILE_PATH_DOT_JS>", UseOnAllPages = true },
    ]);
1.2.1 Inject the service into your controller
private readonly IScriptInjector scriptInjector;

public MyController(IScriptInjector> scriptInjector)
{
     this.scriptInjector = scriptInjector;
}
1.2.2 Methods
scriptInjector.AddScript(new Pixsys.Library.Scripts.ScriptInjector.Models.InjectedScript
{
    Name="<SCRIPT_NAME>",
    Script="<SCRIPT>",
});

scriptInjector.AddPath(new Pixsys.Library.Scripts.ScriptInjector.Models.InjectedPath
{
    Name="<SCRIPT_NAME>",
    Path="https://<PATH>/<FILE>.js",
});
1.3 MVC Views

You can inject scripts directly in the MVC view by calling the script-inject-code and/or script-inject-path tag helpers:

<!DOCTYPE html>
<html>
<head>
</head>
<body>

<script-inject-code name="testfromView" script="console.log('injected Test from view');"></script-inject-code>
<script-inject-path name="signalr" path="https://cdnjs.cloudflare.com/ajax/libs/microsoft-signalr/8.0.0/signalr.min.js"></script-inject-path>

</body>
</html>

The following output will be generated:

<!DOCTYPE html>
<html>
<head>
</head>
<body>

<script nonce="">console.log('injected Test from view');</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/microsoft-signalr/8.0.0/signalr.min.js" nonce=""></script>

</body>
</html>

It is also possible to use one of the registered scripts (is it has not been set to be used on all pages) via the script-inject-call-registered-scripts tag helper:

<!DOCTYPE html>
<html>
<head>
</head>
<body>

<script-inject-call-registered-script name="specific-hello"></script-inject-call-registered-script>

</body>
</html>

The following output will be generated:

<!DOCTYPE html>
<html>
<head>
</head>
<body>

<script nonce="">console.log('registered Hello World on specific pages');</script>

</body>
</html>
1.3 Use of Nonce

In order to be compliant with your content security policy, this package is using the Nonce provider functionality from NetEscapades.AspNetCore.SecurityHeaders

Please refer to the documentation listed here

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 168 11/1/2024